KiokuD...torable(3pm)

πŸ“¦
version 0.57 Β· 3 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing

✨ KiokuDB::Backend::Serialize::Storable ✨

okay so this is a page from the User Contributed Perl Documentation, and the manual name is literally KiokuD...torable(3pm) because someone let the terminal truncate it πŸ’€ (it's KiokuDB::Backend::Serialize::Storable, bestie, we know her). No cap, this whole thing is a Perl role that turns your KiokuDB entries into Storable bytes. Let's get into it 🫢


🌸 NAME 🌸

KiokuDB::Backend::Serialize::Storable β€” the Storable-based serialization of KiokuDB::Entry objects. that's the whole vibe, that's the whole job πŸ’…


⭐ VERSION ⭐

version 0.57


πŸŽ€ SYNOPSIS πŸŽ€

here's the little teaser, exactly as the page gives it:

package MyBackend;

with qw(KiokuDB::Backend::Serialize::Storable;

she's short, she's sweet, she's doing her best ✨


πŸ¦‹ DESCRIPTION πŸ¦‹

so basically: this role hands you Storable-based serialization of KiokuDB::Entry objects for a backend, and it comes with streaming capabilities too. it's giving "plug me into your backend and I'll handle the bytes" 😌

lowkey important though: KiokuDB::Backend::Serialize::Delegate is the preferred way to go. using this one directly? it's allowed, but the page is gently telling you the Delegate is the main character here πŸ‘‘

πŸ’– METHODS πŸ’–

here's the whole lineup, every single one, no skipping 🫢

  • serialize $entry β€” uses nstore in Storable. feeds your entry in and lets Storable do the thing.
  • deserialize $blob β€” uses thaw in Storable. blob goes in, object comes out, iconic.
  • serialize_to_stream $fh, $entry β€” uses nstore_fd in Storable. same energy as serialize but streaming to a filehandle, that's the "streaming capabilities" from the description right there πŸŽ€
  • deserialize_from_stream $fh β€” uses fd_retrieve in Storable. reads it back off the filehandle. periodt.

🌈 AUTHOR 🌈

Yuval Kogman <nothingmuch@woobling.org> β€” shoutout, legend behavior πŸ’œ


This software is copyright (c) 2014 by Yuval Kogman, Infinity Interactive.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay, that's the good license 🫢


okay that's the whole page bestie, we read every line, nothing skipped, you're welcome πŸ’… this was perl v5.34.0, dated 2022-05-23, and it's KiokuD...torable(3pm) forever in our hearts. mwah πŸ“βœ¨

πŸ“¦ where this page comes from