BSON::Bytes(3pm)

BSON::Bytes3pm

Bson type wrapper for binary byte strings

Usage

    use BSON::Types ':all';
    $bytes = bson_bytes( $bytestring );
    $bytes = bson_bytes( $bytestring, $subtype );

Version

version v1.12.2

Overview

This module provides a BSON type wrapper for binary data represented as a string of bytes.

Attributes

data

A scalar, interpreted as bytes. (I.e. "character" data should be encoded to bytes.) It defaults to the empty string.

subtype

A numeric BSON subtype between 0 and 255. This defaults to 0 and generally should not be modified. Subtypes 128 to 255 are "user-defined".

Methods

To_json

Returns Base64 encoded string equivalent to the data attribute.

If the "BSON_EXTJSON" option is true, it will instead be compatible with MongoDB's extended JSON <https://github.com/mongodb/specifications/blob/master/source/extended-json.rst> format, which represents it as a document as follows:

    {"$binary" : { "base64": "<base64 data>", "subType" : "<type>"} }

Overloading

The stringification operator ("") is overloaded to return the binary data and fallback overloading is enabled.

Releases

4 releases since Debian 10 (Buster); the text changed 2 times.

  1. 10
  2. 11–12
  3. 13