Mojo::ByteStream(3)

🌈 Mojo::ByteStream(3) — ByteStream 💅

okay so bestie, this is the Mojo::ByteStream(3) page from User Contributed Perl Documentation, and the manual name is Mojo::ByteStream, aka ByteStream. Let’s get into it ✨

🌸 NAME 🌸

Mojo::ByteStream — ByteStream 🫶

✨ SYNOPSIS ✨

use Mojo::ByteStream;

# Manipulate bytestream
my $stream = Mojo::ByteStream->new('foo_bar_baz');
say $stream->camelize;

# Chain methods
my $stream = Mojo::ByteStream->new('foo bar baz')->quote;
$stream = $stream->unquote->encode('UTF-8')->b64_encode('');
say "$stream";

# Use the alternative constructor
use Mojo::ByteStream qw(b);
my $stream = b('foobarbaz')->b64_encode('')->say;

🦋 DESCRIPTION 🦋

Mojo::ByteStream is literally a scalar-based container for bytestreams that gives you a way friendlier API for lots of the functions in Mojo::Util. It’s giving “tiny wrapper, big helper energy” 💖

# Access scalar directly to manipulate bytestream
my $stream = Mojo::ByteStream->new('foo');
$$stream .= 'bar';

🎀 FUNCTIONS 🎀

Mojo::ByteStream implements these functions, and you can import them individually, bestie ✨

b

my $stream = b('test123');

Construct a new scalar-based Mojo::ByteStream object. Cute, tiny, useful 🎀

💖 METHODS 💖

Mojo::ByteStream implements the following methods.

b64_decode

$stream = $stream->b64_decode;

Base64 decode the bytestream with "b64_decode" in Mojo::Util. Decoding slay 💅

b64_encode

$stream = $stream->b64_encode;
$stream = $stream->b64_encode("\n");

Base64 encode the bytestream with "b64_encode" in Mojo::Util.

# "Zm9vIGJhciBiYXo="
b('foo bar baz')->b64_encode('');

camelize

$stream = $stream->camelize;

Camelize the bytestream with "camelize" in Mojo::Util. CamelCase era 🐪✨

clone

my $stream2 = $stream->clone;

Return a new Mojo::ByteStream object cloned from this bytestream. Twin behavior, no cap 👯

decamelize

$stream = $stream->decamelize;

Decamelize the bytestream with "decamelize" in Mojo::Util.

decode

$stream = $stream->decode;
$stream = $stream->decode('iso-8859-1');

Decode the bytestream with "decode" in Mojo::Util; it defaults to using "UTF-8".

# "♥"
b('%E2%99%A5')->url_unescape->decode;

encode

$stream = $stream->encode;
$stream = $stream->encode('iso-8859-1');

Encode the bytestream with "encode" in Mojo::Util; it defaults to using "UTF-8".

# "%E2%99%A5"
b('♥')->encode->url_escape;

gunzip

$stream = $stream->gunzip;

Uncompress the bytestream with "gunzip" in Mojo::Util. Unzip and unbothered 🦋

gzip

stream = $stream->gzip;

Compress the bytestream with "gzip" in Mojo::Util.

hmac_sha1_sum

$stream = $stream->hmac_sha1_sum('passw0rd');

Generate an HMAC-SHA1 checksum for the bytestream with "hmac_sha1_sum" in Mojo::Util.

# "7fbdc89263974a89210ea71f171c77d3f8c21471"
b('foo bar baz')->hmac_sha1_sum('secr3t');

html_unescape

$stream = $stream->html_unescape;

Unescape all HTML entities in the bytestream with "html_unescape" in Mojo::Util.

# "%3Chtml%3E"
b('<html>')->html_unescape->url_escape;

humanize_bytes

$stream = $stream->humanize_bytes;

Turn the number of bytes into a simplified human-readable format for the bytestream with "humanize_bytes" in Mojo::Util. Numbers but make them make sense 🍓

md5_bytes

$stream = $stream->md5_bytes;

Generate a binary MD5 checksum for the bytestream with "md5_bytes" in Mojo::Util.

md5_sum

$stream = $stream->md5_sum;

Generate an MD5 checksum for the bytestream with "md5_sum" in Mojo::Util.

new

my $stream = Mojo::ByteStream->new('test123');

Construct a new scalar-based Mojo::ByteStream object. Main character constructor energy 👑

punycode_decode

$stream = $stream->punycode_decode;

Punycode decode the bytestream with "punycode_decode" in Mojo::Util.

punycode_encode

$stream = $stream->punycode_encode;

Punycode encode the bytestream with "punycode_encode" in Mojo::Util.

quote

$stream = $stream->quote;

Quote the bytestream with "quote" in Mojo::Util.

say

$stream = $stream->say;
$stream = $stream->say(*STDERR);

Print the bytestream to a handle and append a newline; it defaults to using "STDOUT". Say it with your chest 🗣️💬

secure_compare

my $bool = $stream->secure_compare($str);

Compare the bytestream with "secure_compare" in Mojo::Util.

sha1_bytes

$stream = $stream->sha1_bytes;

Generate a binary SHA1 checksum for the bytestream with "sha1_bytes" in Mojo::Util.

sha1_sum

$stream = $stream->sha1_sum;

Generate a SHA1 checksum for the bytestream with "sha1_sum" in Mojo::Util.

size

my $size = $stream->size;

Size of the bytestream. How big is the vibe check 📏

slugify

$stream = $stream->slugify;
$stream = $stream->slugify($bool);

Generate a URL slug for the bytestream with "slugify" in Mojo::Util.

split

my $collection = $stream->split(',');
my $collection = $stream->split(',', -1);

Turn the bytestream into a Mojo::Collection object containing Mojo::ByteStream objects.

# "One,Two,Three"
b("one,two,three")->split(',')->map('camelize')->join(',');

# "One,Two,Three,,,"
b("one,two,three,,,")->split(',', -1)->map('camelize')->join(',');

tap

$stream = $stream->tap(sub {...});

Alias for "tap" in Mojo::Base. Peek at it, don’t change it, periodt 👀

term_escape

$stream = $stream->term_escape;

Escape POSIX control characters in the bytestream with "term_escape" in Mojo::Util.

# Print binary checksum to terminal
b('foo')->sha1_bytes->term_escape->say;

to_string

my $str = $stream->to_string;

Stringify the bytestream.

trim

$stream = $stream->trim;

Trim whitespace characters from both ends of the bytestream with "trim" in Mojo::Util. Snip snip ✂️✨

unindent

$stream = $stream->unindent;

Unindent the bytestream with "unindent" in Mojo::Util.

unquote

$stream = $stream->unquote;

Unquote the bytestream with "unquote" in Mojo::Util.

url_escape

$stream = $stream->url_escape;
$stream = $stream->url_escape('^A-Za-z0-9\-._~');

Percent encode all unsafe characters in the bytestream with "url_escape" in Mojo::Util.

# "%E2%98%83"
b('☃')->encode->url_escape;

url_unescape

$stream = $stream->url_unescape;

Decode percent-encoded characters in the bytestream with "url_unescape" in Mojo::Util.

# "<html>"
b('%3Chtml%3E')->url_unescape->xml_escape;

with_roles

my $new_class = Mojo::ByteStream->with_roles('Mojo::ByteStream::Role::One');
my $new_class = Mojo::ByteStream->with_roles('+One', '+Two');
$stream       = $stream->with_roles('+One', '+Two');

Alias for "with_roles" in Mojo::Base. Roles? We love a flexible icon 🌈

xml_escape

$stream = $stream->xml_escape;

Escape only the characters &, <, >, " and ' in the bytestream with "xml_escape" in Mojo::Util.

xor_encode

$stream = $stream->xor_encode($key);

XOR encode the bytestream with "xor_encode" in Mojo::Util.

# "%04%0E%15B%03%1B%10"
b('foo bar')->xor_encode('baz')->url_escape;

👑 OPERATORS 👑

Mojo::ByteStream overloads these operators.

bool

my $bool = !!$bytestream;

Always true. Always that girl 💅

stringify

my $str = "$bytestream";

Alias for "to_string".

🔥 SEE ALSO 🔥

Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.

---

mwah 💋 this page is from perl v5.42.0, dated 2026-07-15, and it’s the Mojo::ByteStream(3) manual — byeeee 🫶✨