File Coverage

blib/lib/BSON/Binary.pm

Criterion	Covered	Total	%
statement	30	35	85.7
branch	4	4	100.0
condition	2	3	66.6
subroutine	10	11	90.9
pod	0	6	0.0
total	46	59	77.9

use 5.010001;
use strict;
use warnings;

package BSON::Binary;
# ABSTRACT: Legacy BSON type wrapper for binary data (DEPRECATED)

use version;
our $VERSION = 'v1.12.2';

our $TYPE_SIMPLE       = 0x00;
our $TYPE_BYTES        = 0x02;
our $TYPE_UUID         = 0x03;
our $TYPE_MD5          = 0x05;
our $TYPE_USER_DEFINED = 0x80;

sub new {
    my ( $class, $data, $type ) = @_;
    $type ||= $TYPE_SIMPLE;
    my $self = bless { type => $type }, $class;
    $self->data($data);
    return $self;
}

sub data {
    my ( $self, $data ) = @_;
    if ( defined $data ) {
        $data = [ unpack( 'C*', $data ) ] unless ref $data eq 'ARRAY';
        $self->{data} = $data;
    }
    return $self->{data};
}

sub type {
    return $_[0]->{type};
}

# alias for compatibility with BSON::Bytes
sub subtype {
    return $_[0]->{type};
}

sub to_s {
    my $self = shift;
    my @data = @{ $self->data };
    return pack( 'ltype, @data );
}

sub TO_JSON {
    my %data;
    tie( %data, 'Tie::IxHash' );
    $data{base64} = $_[0]->to_s;
    $data{subType} = $_[0]->{type};
    return { '$binary' => \%data };
}

use overload '""' => \&to_s;

1;

=pod

=encoding UTF-8

=head1 NAME

BSON::Binary - Legacy BSON type wrapper for binary data (DEPRECATED)

=head1 VERSION

version v1.12.2

=head1 DESCRIPTION

This module has been deprecated as it was horribly inefficient (unpacking
binary data to individual single-byte elements of an array!) and had a
weird API that was not compatible with the existing MongoDB Binary wrapper
implementation on CPAN.

You are strongly encouraged to use L instead.

=for Pod::Coverage new data type subtype to_s TO_JSON

=head1 AUTHORS

=over 4

=item *

David Golden

=item *

Stefan G.

=back

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Stefan G. and MongoDB, Inc.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004

=cut

__END__