File Coverage

blib/lib/Mango/BSON/Binary.pm

Criterion	Covered	Total	%
statement	11	12	91.6
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod	1	1	100.0
total	17	18	94.4

package Mango::BSON::Binary;
use Mojo::Base -base;
use overload bool => sub {1}, '""' => sub { shift->data }, fallback => 1;

use Mojo::Util 'b64_encode';

has [qw(data type)];

sub TO_JSON { b64_encode shift->data, '' }

1;

=encoding utf8

=head1 NAME

Mango::BSON::Binary - Binary type

=head1 SYNOPSIS

  use Mango::BSON::Binary;

  my $bin = Mango::BSON::Binary->new(data => $bytes, type => 'generic');
  say $bin->data;

=head1 DESCRIPTION

L is a container for the BSON binary type used by
L. For C implementations like L, that support
the C method, it will automatically C encode the binary data.

=head1 ATTRIBUTES

L implements the following attributes.

=head2 data

  my $bytes = $bin->data;
  $bin      = $bin->data($bytes);

Binary data.

=head2 type

  my $type = $bin->type;
  $bin     = $bin->type('generic');

Binary subtype.

=head1 METHODS

L inherits all methods from L and implements
the following new ones.

=head2 TO_JSON

  my $b64 = $bin->TO_JSON;

Base64 encode L.

=head1 OPERATORS

L overloads the following operators.

=head2 bool

  my $bool = !!$bin;

Always true.

=head2 stringify

  my $str = "$bin";

Alias for L.

=head1 SEE ALSO

L, L, L.

=cut