Struct bson::Binary

pub struct Binary {
    pub subtype: BinarySubtype,
    pub bytes: Vec<u8>,
}

Represents a BSON binary value.

Fields

subtype: BinarySubtype

The subtype of the bytes.

bytes: Vec<u8>

The binary bytes.

Implementations

impl Binary

pub fn from_base64( input: impl AsRef<str>, subtype: impl Into<Option<BinarySubtype>> ) -> Result<Self>

Creates a Binary from a base64 string and optional BinarySubtype. If the subtype argument is None, the Binary constructed will default to BinarySubtype::Generic.

let input = base64::encode("hello");
let binary = Binary::from_base64(input, None)?;
println!("{:?}", binary);
// binary: Binary { subtype: Generic, bytes: [104, 101, 108, 108, 111] }

pub fn as_raw_binary(&self) -> RawBinaryRef<'_>

Borrow the contents as a RawBinaryRef.

impl Binary

pub fn from_uuid(uuid: Uuid) -> Self

Serializes a Uuid into BSON Binary type

pub fn from_uuid_with_representation( uuid: Uuid, rep: UuidRepresentation ) -> Self

Serializes a Uuid into BSON binary type and takes the desired representation as a parameter. Binary::from_uuid_with_representation(uuid, UuidRepresentation::Standard) is equivalent to Binary::from_uuid(uuid).

See the documentation for UuidRepresentation for more information on the possible representations.

pub fn to_uuid_with_representation( &self, rep: UuidRepresentation ) -> Result<Uuid>

Deserializes a BSON Binary type into a Uuid according to the provided representation. If the representation does not match the Binary, an error will be returned.

See the documentation for UuidRepresentation for more information on the possible representations.

pub fn to_uuid(&self) -> Result<Uuid>

Deserializes a BSON Binary type into a Uuid using the standard representation.

Trait Implementations

impl Clone for Binary

fn clone(&self) -> Binary

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Binary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Binary

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Binary

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> From<&'a Binary> for RawBsonRef<'a>

fn from(bin: &'a Binary) -> Self

Converts to this type from the input type.

impl From<Binary> for Bson

fn from(binary: Binary) -> Bson

Converts to this type from the input type.

impl From<Binary> for RawBson

fn from(b: Binary) -> Self

Converts to this type from the input type.

impl From<Uuid> for Binary

Available on crate feature uuid-1 only.

fn from(uuid: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for Binary

fn from(uuid: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for Binary

Available on crate feature uuid-0_8 only.

fn from(uuid: Uuid) -> Self

Converts to this type from the input type.

impl PartialEq for Binary

fn eq(&self, other: &Binary) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Binary

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Binary