Struct bson::Uuid

pub struct Uuid { /* private fields */ }

A struct modeling a BSON UUID value (i.e. a Binary value with subtype 4).

This type should be used instead of uuid::Uuid when serializing to or deserializing from BSON, since uuid::Uuid’s serde implementation doesn’t produce or parse BSON UUIDs.

To enable interop with the Uuid type from the uuid crate, enable the uuid-0_8 feature flag.

For more information on the usage of this type, see the uuid module-level documentation.

Note: due to an issue in serde (see here), this type will also allow deserialization from 16 byte + subtype 0 Binary values in BSON if part of a #[serde(flatten)] chain. This behavior shouldn’t be relied upon as it may be fixed at some point in the future.

Implementations

impl Uuid

pub fn new() -> Self

Creates a random UUID.

This uses the operating system’s RNG as the source of random numbers. If you’d like to use a custom generator, generate random bytes and pass them to Uuid::from_bytes instead.

pub const fn from_bytes(bytes: [u8; 16]) -> Self

Creates a Uuid using the supplied big-endian bytes.

pub fn parse_str(input: impl AsRef<str>) -> Result<Self>

Creates a Uuid from the provided hex string.

pub const fn bytes(self) -> [u8; 16]

Returns an array of 16 bytes containing the Uuid’s data.

impl Uuid

pub fn from_uuid_0_8(uuid: Uuid) -> Self

Available on crate feature uuid-0_8 only.

Create a Uuid from a uuid::Uuid from the uuid crate.

pub fn to_uuid_0_8(self) -> Uuid

Available on crate feature uuid-0_8 only.

Convert this Uuid to a uuid::Uuid from the uuid crate.

impl Uuid

pub fn from_uuid_1(uuid: Uuid) -> Self

Available on crate feature uuid-1 only.

Create a Uuid from a uuid::Uuid from the uuid crate.

pub fn to_uuid_1(self) -> Uuid

Available on crate feature uuid-1 only.

Convert this Uuid to a uuid::Uuid from the uuid crate.

Trait Implementations

impl Clone for Uuid

fn clone(&self) -> Uuid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Uuid

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

Formats the value using the given formatter.

impl Default for Uuid

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Uuid

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'de> DeserializeAs<'de, Uuid> for Uuid

Available on crate features uuid-0_8 and serde_with only.

fn deserialize_as<D>(deserializer: D) -> Result<Uuid, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'de> DeserializeAs<'de, Uuid> for Uuid

Available on crate features uuid-1 and serde_with only.

fn deserialize_as<D>(deserializer: D) -> Result<Uuid, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Uuid

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

Formats the value using the given formatter.

impl From<Uuid> for Binary

fn from(uuid: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for Bson

fn from(u: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for Uuid

fn from(u: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for Uuid

fn from(s: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for Uuid

fn from(u: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for Uuid

fn from(s: Uuid) -> Self

Converts to this type from the input type.

impl Hash for Uuid

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Uuid

fn cmp(&self, other: &Uuid) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<Uuid> for Uuid

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

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

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

This method tests for !=.

impl PartialOrd<Uuid> for Uuid

fn partial_cmp(&self, other: &Uuid) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Uuid

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

Serialize this value into the given Serde serializer.

impl SerializeAs<Uuid> for Uuid

Available on crate features uuid-0_8 and serde_with only.

fn serialize_as<S>(source: &Uuid, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl SerializeAs<Uuid> for Uuid

Available on crate features uuid-1 and serde_with only.

fn serialize_as<S>(source: &Uuid, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Copy for Uuid

impl Eq for Uuid

impl StructuralEq for Uuid

impl StructuralPartialEq for Uuid