Enum bson::UuidRepresentation

#[non_exhaustive]
pub enum UuidRepresentation {
    Standard,
    CSharpLegacy,
    JavaLegacy,
    PythonLegacy,
}

Enum of the possible representations to use when converting between Uuid and Binary. This enum is necessary because the different drivers used to have different ways of encoding UUIDs, with the BSON subtype: 0x03 (UUID old). If a UUID has been serialized with a particular representation, it MUST be deserialized with the same representation.

Example:

use bson::{Binary, uuid::{Uuid, UuidRepresentation}};

let uuid = Uuid::parse_str("00112233445566778899AABBCCDDEEFF")?;
let bin = Binary::from_uuid_with_representation(uuid, UuidRepresentation::PythonLegacy);

// This conversion fails, since the binary holds a PythonLegacy UUID, so we're required to specify
// that.
assert!(bin.to_uuid().is_err());

// This conversion succeeds, since we specified the correct representation.
let new_uuid = bin.to_uuid_with_representation(UuidRepresentation::PythonLegacy)?;
assert_eq!(new_uuid, uuid);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Standard

The canonical representation of UUIDs in BSON (binary with subtype 0x04)

CSharpLegacy

The legacy representation of UUIDs in BSON used by the C# driver (binary subtype 0x03)

JavaLegacy

The legacy representation of UUIDs in BSON used by the Java driver (binary subtype 0x03)

PythonLegacy

The legacy representation of UUIDs in BSON used by the Python driver, which is the same format as STANDARD, but has binary subtype 0x03

Trait Implementations

impl Clone for UuidRepresentation

fn clone(&self) -> UuidRepresentation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UuidRepresentation

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

Formats the value using the given formatter.

impl PartialEq<UuidRepresentation> for UuidRepresentation

fn eq(&self, other: &UuidRepresentation) -> 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 !=.

impl Copy for UuidRepresentation

impl StructuralPartialEq for UuidRepresentation