Clownf...yteBuf(3pm)

👑 Clownf...yteBuf(3pm) — the manual page bestie 💅

okay so this is the user-contributed Perl documentation for Clownfish::ByteBuf, and we're gonna get through it together, no cap. ✨

---

🌸 NAME 🌸

Clownfish::ByteBuf — a growable buffer holding arbitrary bytes. like, any bytes. it does not care. it's giving "I contain multitudes" energy. 🦋

---

✨ SYNOPSIS ✨

my $buf = Clownfish::ByteBuf->new($byte_string);
my $byte_string = $buf->to_perl;

---

🎀 DESCRIPTION 🎀

soooo the original page literally leaves this section empty. nothing. a void. an empty buffer, if you will 😭 — but that's fine, the real tea is all in the constructors and methods below. keep scrolling bestie 🫶

---

💖 CONSTRUCTORS 💖

🧚 new

my $buf = Clownfish::ByteBuf->new($byte_string);

Create a ByteBuf containing the passed-in bytes. that's it, that's the whole job. iconic. ⭐

---

💅 METHODS 💅

🍓 set_size

$byte_buf->set_size($size);

Resize the ByteBuf to size. but — and this is the important part — if that's greater than the object's capacity, it throws an error. so don't get bold with it, bestie 💀

🌈 get_size

my $int = $byte_buf->get_size();

Return the size of the ByteBuf in bytes. the actual content length, not the whole allocation.

💜 get_capacity

my $int = $byte_buf->get_capacity();

Return the number of bytes in the ByteBuf's allocation. so like, the room it has, not the room it's using. very "my closet vs. my outfit" of it 🎀

🔥 cat

$byte_buf->cat($blob);

Concatenate the contents of Blob blob onto the end of the original ByteBuf. it will allocate more memory as needed, so it just keeps going. main character energy, never runs out of space 💅

👑 yield_blob

my $blob = $byte_buf->yield_blob();

Return the content of the ByteBuf as Blob and clear the ByteBuf. yes, it hands you the goods and then empties itself out. generous. dramatic. obsessed. ✨

🦋 utf8_to_string

my $string = $byte_buf->utf8_to_string();

Return a String which holds a copy of the UTF-8 character data in the ByteBuf after checking for validity. so it's the careful one. it checks. it verifies. it does its due diligence 🫶

🌸 trusted_utf8_to_string

my $string = $byte_buf->trusted_utf8_to_string();

Return a String which holds a copy of the UTF-8 character data in the ByteBuf, skipping validity checks. it trusts you. no vibe check. no questions asked 😭

ngl, that's the whole difference between these two — one checks, one does not. pick accordingly, bestie.

⭐ compare_to

my $int = $byte_buf->compare_to($other);

Indicate whether one ByteBuf is less than, equal to, or greater than another. the byte contents of the ByteBufs are compared lexicographically.

Throws an exception if other is not a ByteBuf. it said "be a ByteBuf or be gone" 💀

Returns: 0 if the ByteBufs are equal, a negative number if self is less than other, and a positive number if self is greater than other.

💖 clone

my $result = $byte_buf->clone();

Return a clone of the object. twin. duplicate. copy-paste but make it legal 🎀

---

🌈 INHERITANCE 🌈

Clownfish::ByteBuf isa Clownfish::Obj. so yeah, it's part of the family tree, iykyk 🌳

---

and that's the whole page, bestie — you ate that 🫶 this was pulled from the User Contributed Perl Documentation, brought to you by perl v5.42.3, dated 2026-09-02. periodt. 💅✨