Scroll to navigation

Mojo::ByteStream(3pm) User Contributed Perl Documentation Mojo::ByteStream(3pm)

NAME

Mojo::ByteStream - ByteStream

SYNOPSIS

  # Manipulate bytestreams
  use Mojo::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 'b';
  my $stream = b('foobarbaz')->html_escape;

DESCRIPTION

Mojo::ByteStream provides a more friendly API for the bytestream manipulation functions in Mojo::Util.

FUNCTIONS

Mojo::ByteStream implements the following functions.

"b"

  my $stream = b('test123');
Construct a new Mojo::ByteStream object.

METHODS

Mojo::ByteStream implements the following methods.

"new"

  my $stream = Mojo::ByteStream->new('test123');
Construct a new Mojo::ByteStream object.

"b64_decode"

  $stream = $stream->b64_decode;
Alias for "b64_decode" in Mojo::Util.

"b64_encode"

  $stream = $stream->b64_encode;
  $stream = $stream->b64_encode("\n");
Alias for "b64_encode" in Mojo::Util.
  b('foo bar baz')->b64_encode('')->say;

"camelize"

  $stream = $stream->camelize;
Alias for "camelize" in Mojo::Util.

"clone"

  my $stream2 = $stream->clone;
Clone bytestream.

"decamelize"

  $stream = $stream->decamelize;
Alias for "b64_decamelize" in Mojo::Util.

"decode"

  $stream = $stream->decode;
  $stream = $stream->decode('iso-8859-1');
Alias for "decode" in Mojo::Util, defaults to "UTF-8".
  $stream->decode('UTF-16LE')->unquote->trim->say;

"encode"

  $stream = $stream->encode;
  $stream = $stream->encode('iso-8859-1');
Alias for "encode" in Mojo::Util, defaults to "UTF-8".
  $stream->trim->quote->encode->say;

"hmac_md5_sum"

  $stream = $stream->hmac_md5_sum('passw0rd');
Alias for "hmac_md5_sum" in Mojo::Util.

"hmac_sha1_sum"

  $stream = $stream->hmac_sha1_sum('passw0rd');
Alias for "hmac_sha1_sum" in Mojo::Util.
  b('foo bar baz')->hmac_sha1_sum('secr3t')->quote->say;

"html_escape"

  $stream = $stream->html_escape;
  $stream = $stream->html_escape('^\n\r\t !#$%(-;=?-~');
Alias for "html_escape" in Mojo::Util.
  b('<html>')->html_escape->say;

"html_unescape"

  $stream = $stream->html_unescape;
Alias for "html_unescape" in Mojo::Util.
  b('&lt;html&gt;')->html_unescape->url_escape->say;

"md5_bytes"

  $stream = $stream->md5_bytes;
Alias for "md5_bytes" in Mojo::Util.

"md5_sum"

  $stream = $stream->md5_sum;
Alias for "md5_sum" in Mojo::Util.

"punycode_decode"

  $stream = $stream->punycode_decode;
Alias for "punycode_decode" in Mojo::Util.

"punycode_encode"

  $stream = $stream->punycode_encode;
Alias for "punycode_encode" in Mojo::Util.

"qp_decode"

  $stream = $stream->qp_decode;
Alias for "qp_decode" in Mojo::Util.

"qp_encode"

  $stream = $stream->qp_encode;
Alias for "qp_encode" in Mojo::Util.

"quote"

  $stream = $stream->quote;
Alias for "quote" in Mojo::Util.

"say"

  $stream->say;
  $stream->say(*STDERR);
Print bytestream to handle or STDOUT and append a newline.

"secure_compare"

  my $success = $stream->secure_compare($string);
Alias for "secure_compare" in Mojo::Util.
  say 'Match!' if b('foo')->secure_compare('foo');

"sha1_bytes"

  $stream = $stream->sha1_bytes;
Alias for "sha1_bytes" in Mojo::Util.

"sha1_sum"

  $stream = $stream->sha1_sum;
Alias for "sha1_sum" in Mojo::Util.

"size"

  my $size = $stream->size;
Size of bytestream.

"split"

  my $collection = $stream->split(',');
Turn bytestream into Mojo::Collection.
  b('a,b,c')->split(',')->map(sub { $_->quote })->join("\n")->say;

"to_string"

  my $string = $stream->to_string;
Stringify bytestream.

"trim"

  $stream = $stream->trim;
Alias for "trim" in Mojo::Util.

"unquote"

  $stream = $stream->unquote;
Alias for "unquote" in Mojo::Util.

"url_escape"

  $stream = $stream->url_escape;
  $stream = $stream->url_escape('^A-Za-z0-9\-._~');
Alias for "url_escape" in Mojo::Util.
  b('foo bar baz')->url_escape->say;

"url_unescape"

  $stream = $stream->url_unescape;
Alias for "url_unescape" in Mojo::Util.
  b('%3Chtml%3E')->url_unescape->html_escape->say;

"xml_escape"

  $stream = $stream->xml_escape;
Alias for "xml_escape" in Mojo::Util.

SEE ALSO

Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.
2012-09-05 perl v5.14.2