.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Mango::BSON::Binary 3pm" .TH Mango::BSON::Binary 3pm "2020-06-05" "perl v5.30.3" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Mango::BSON::Binary \- Binary type .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Mango::BSON::Binary; \& \& my $bin = Mango::BSON::Binary\->new(data => $bytes, type => \*(Aqgeneric\*(Aq); \& say $bin\->data; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Mango::BSON::Binary is a container for the \s-1BSON\s0 binary type used by Mango::BSON. For \f(CW\*(C`JSON\*(C'\fR implementations like Mojo::JSON, that support the \f(CW\*(C`TO_JSON\*(C'\fR method, it will automatically \f(CW\*(C`Base64\*(C'\fR encode the binary data. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" Mango::BSON::Binary implements the following attributes. .SS "data" .IX Subsection "data" .Vb 2 \& my $bytes = $bin\->data; \& $bin = $bin\->data($bytes); .Ve .PP Binary data. .SS "type" .IX Subsection "type" .Vb 2 \& my $type = $bin\->type; \& $bin = $bin\->type(\*(Aqgeneric\*(Aq); .Ve .PP Binary subtype. .SH "METHODS" .IX Header "METHODS" Mango::BSON::Binary inherits all methods from Mojo::Base and implements the following new ones. .SS "\s-1TO_JSON\s0" .IX Subsection "TO_JSON" .Vb 1 \& my $b64 = $bin\->TO_JSON; .Ve .PP Base64 encode \*(L"data\*(R". .SH "OPERATORS" .IX Header "OPERATORS" Mango::BSON::Binary overloads the following operators. .SS "bool" .IX Subsection "bool" .Vb 1 \& my $bool = !!$bin; .Ve .PP Always true. .SS "stringify" .IX Subsection "stringify" .Vb 1 \& my $str = "$bin"; .Ve .PP Alias for \*(L"data\*(R". .SH "SEE ALSO" .IX Header "SEE ALSO" Mango, Mojolicious::Guides, .