GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MOJO::BYTESTREAM (3)

.ds Aq ’

NAME

Mojo::ByteStream - ByteStream

CONTENTS

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 b;
  my $stream = b(foobarbaz)->b64_encode()->say;



DESCRIPTION

Mojo::ByteStream is a scalar-based container for bytestreams that provides a more friendly API for many of the functions in Mojo::Util.



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



FUNCTIONS

Mojo::ByteStream implements the following functions, which can be imported individually.

    b



  my $stream = b(test123);



Construct a new scalar-based Mojo::ByteStream object.

METHODS

Mojo::ByteStream implements the following methods.

    b64_decode



  $stream = $stream->b64_decode;



Base64 decode bytestream with b64_decode in Mojo::Util.

    b64_encode



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



Base64 encode bytestream with b64_encode in Mojo::Util.



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



    camelize



  $stream = $stream->camelize;



Camelize bytestream with camelize in Mojo::Util.

    clone



  my $stream2 = $stream->clone;



Clone bytestream.

    decamelize



  $stream = $stream->decamelize;



Decamelize bytestream with decamelize in Mojo::Util.

    decode



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



Decode bytestream with decode in Mojo::Util, defaults to using UTF-8.



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



    encode



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



Encode bytestream with encode in Mojo::Util, defaults to using UTF-8.



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



    hmac_sha1_sum



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



Generate HMAC-SHA1 checksum for 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 bytestream with html_unescape in Mojo::Util.



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



    md5_bytes



  $stream = $stream->md5_bytes;



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

    md5_sum



  $stream = $stream->md5_sum;



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

    new



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



Construct a new scalar-based Mojo::ByteStream object.

    punycode_decode



  $stream = $stream->punycode_decode;



Punycode decode bytestream with punycode_decode in Mojo::Util.

    punycode_encode



  $stream = $stream->punycode_encode;



Punycode encode bytestream with punycode_encode in Mojo::Util.

    quote



  $stream = $stream->quote;



Quote bytestream with quote in Mojo::Util.

    say



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



Print bytestream to handle and append a newline, defaults to using STDOUT.

    secure_compare



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



Compare bytestream with secure_compare in Mojo::Util.

    sha1_bytes



  $stream = $stream->sha1_bytes;



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

    sha1_sum



  $stream = $stream->sha1_sum;



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

    size



  my $size = $stream->size;



Size of bytestream.

    slurp



  $stream = $stream->slurp;



Read all data at once from file into bytestream with slurp in Mojo::Util.



  # Read file and print lines in random order
  b(/home/sri/myapp.pl)->slurp->split("\n")->shuffle->join("\n")->say;



    spurt



  $stream = $stream->spurt(/home/sri/myapp.pl);



Write all data from bytestream at once to file with spurt in Mojo::Util.



  # Remove unnecessary whitespace from file
  b(/home/sri/foo.txt)->slurp->squish->spurt(/home/sri/bar.txt);



    split



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



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



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



    squish



  $stream = $stream->squish;



Trim whitespace characters from both ends of bytestream and then change all consecutive groups of whitespace into one space each with squish in Mojo::Util.

    tap



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



Alias for tap in Mojo::Base.

    term_escape



  $stream = $stream->term_escape;



Escape POSIX control characters in 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 bytestream.

    trim



  $stream = $stream->trim;



Trim whitespace characters from both ends of bytestream with trim in Mojo::Util.

    unindent



  $stream = $stream->unindent;



Unindent bytestream with unindent in Mojo::Util.

    unquote



  $stream = $stream->unquote;



Unquote 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 bytestream with url_escape in Mojo::Util.



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



    url_unescape



  $stream = $stream->url_unescape;



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



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



    xml_escape



  $stream = $stream->xml_escape;



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

    xor_encode



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



XOR encode 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 the following operators.

    bool



  my $bool = !!$bytestream;



Always true.

    stringify



  my $str = "$bytestream";



Alias for to_string.

SEE ALSO

Mojolicious, Mojolicious::Guides, <http://mojolicious.org>.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MOJO::BYTESTREAM (3) 2016-03-15

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.