/usr/lib/x86_64-linux-gnu/perl5/5.22/MongoDB/BSON/Binary.pm is in libmongodb-perl 1.2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | #
# Copyright 2009-2013 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
package MongoDB::BSON::Binary;
# ABSTRACT: MongoDB binary type
use version;
our $VERSION = 'v1.2.2';
use Moo;
use Types::Standard qw(
Int
Str
);
use namespace::clean;
use constant {
SUBTYPE_GENERIC => 0,
SUBTYPE_FUNCTION => 1,
SUBTYPE_GENERIC_DEPRECATED => 2,
SUBTYPE_UUID_DEPRECATED => 3,
SUBTYPE_UUID => 4,
SUBTYPE_MD5 => 5,
SUBTYPE_USER_DEFINED => 128
};
use overload (
q{""} => sub { $_[0]->{data} },
fallback => 1
);
#pod =attr data
#pod
#pod A string of binary data.
#pod
#pod =cut
has data => (
is => 'ro',
isa => Str,
required => 1
);
#pod =attr subtype
#pod
#pod A subtype. Defaults to C<SUBTYPE_GENERIC>.
#pod
#pod =cut
has subtype => (
is => 'ro',
isa => Int,
required => 0,
default => MongoDB::BSON::Binary->SUBTYPE_GENERIC
);
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
MongoDB::BSON::Binary - MongoDB binary type
=head1 VERSION
version v1.2.2
=head1 SYNOPSIS
Creates an instance of binary data with a specific subtype.
=head1 USAGE
For example, suppose we wanted to store a profile pic.
my $pic = MongoDB::BSON::Binary->new(data => $pic_bytes);
$collection->insert({name => "profile pic", pic => $pic});
You can also, optionally, specify a subtype:
my $pic = MongoDB::BSON::Binary->new(data => $pic_bytes,
subtype => MongoDB::BSON::Binary->SUBTYPE_GENERIC);
$collection->insert({name => "profile pic", pic => $pic});
=head2 Overloading
MongoDB::BSON::Binary objects have stringification overloaded to return
the binary data.
=head1 ATTRIBUTES
=head2 data
A string of binary data.
=head2 subtype
A subtype. Defaults to C<SUBTYPE_GENERIC>.
=head1 SUBTYPES
MongoDB allows you to specify the "flavor" of binary data that you are storing
by providing a subtype. The subtypes are purely cosmetic: the database treats
them all the same.
There are several subtypes defined in the BSON spec:
=over 4
=item C<SUBTYPE_GENERIC> (0x00) is the default used by the driver (as of 0.46).
=item C<SUBTYPE_FUNCTION> (0x01) is for compiled byte code.
=item C<SUBTYPE_GENERIC_DEPRECATED> (0x02) is deprecated. It was used by the
driver prior to version 0.46, but this subtype wastes 4 bytes of space so
C<SUBTYPE_GENERIC> is preferred. This is the only type that is parsed
differently based on type.
=item C<SUBTYPE_UUID_DEPRECATED> (0x03) is deprecated. It is for UUIDs.
=item C<SUBTYPE_UUID> (0x04) is for UUIDs.
=item C<SUBTYPE_MD5> can be (0x05) is for MD5 hashes.
=item C<SUBTYPE_USER_DEFINED> (0x80) is for user-defined binary types.
=back
=head2 Why is C<SUBTYPE_GENERIC_DEPRECATED> deprecated?
Binary data is stored with the length of the binary data, the subtype, and the
actually data. C<SUBTYPE_GENERIC DEPRECATED> stores the length of the data a
second time, which just wastes four bytes.
If you have been using C<SUBTYPE_GENERIC_DEPRECATED> for binary data, moving to
C<SUBTYPE_GENERIC> should be painless: just use the driver normally and all
new/resaved data will be stored as C<SUBTYPE_GENERIC>.
It gets a little trickier if you've been querying by binary data fields:
C<SUBTYPE_GENERIC> won't match C<SUBTYPE_GENERIC_DEPRECATED>, even if the data
itself is the same.
=head2 Why is C<SUBTYPE_UUID_DEPRECATED> deprecated?
Other languages were using the UUID type to deserialize into their languages'
native UUID type. They were doing this in different ways, so to standardize,
they decided on a deserialization format for everyone to use and changed the
subtype for UUID to the universal format.
This should not affect Perl users at all, as Perl does not deserialize it into
any native UUID type.
=head1 AUTHORS
=over 4
=item *
David Golden <david@mongodb.com>
=item *
Mike Friedman <friedo@friedo.com>
=item *
Kristina Chodorow <k.chodorow@gmail.com>
=item *
Florian Ragwitz <rafl@debian.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2016 by MongoDB, Inc..
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
|