perldoc > BSON::Bytes

man perldoc info pydoc3 ri search

📛 NAME

BSON::Bytes - BSON type wrapper for binary byte strings

🚀 Quick Reference

Use Case	Command	Description
Create BSON bytes from binary string	my $bytes = bson_bytes( $data );	Wraps a scalar as a BSON::Bytes object (default subtype 0)
Create BSON bytes with subtype	my $bytes = bson_bytes( $data, 0x05 );	Sets a user-defined subtype (0‑255)
Get raw binary string	my $str = "$bytes";	Stringification operator returns the binary data
Convert to Base64 JSON	my $json = $bytes->TO_JSON;	Returns a Base64‑encoded string
Get extended JSON (MongoDB)	$BSON::Types::BSON_EXTJSON = 1; my $ext = $bytes->TO_JSON;	Outputs a $binary document per MongoDB extended JSON

📌 VERSION

version v1.12.2

📝 SYNOPSIS

use BSON::Types ':all';

$bytes = bson_bytes( $bytestring );
$bytes = bson_bytes( $bytestring, $subtype );

📖 DESCRIPTION

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.

👥 AUTHORS

• 👤 David Golden <david AT mongodb.com>
• 👤 Stefan G. <minimalist AT lavabit.com>

⚖️ 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

📛 NAME 🚀 Quick Reference 📌 VERSION 📝 SYNOPSIS 📖 DESCRIPTION 🔧 ATTRIBUTES 🛠️ METHODS ⚡️ OVERLOADING 👥 AUTHORS ⚖️ COPYRIGHT AND LICENSE