Struct 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() -> Uuid

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]) -> Uuid

Creates a Uuid using the supplied big-endian bytes.

pub fn parse_str(input: impl AsRef<str>) -> Result<Uuid, Error>

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.

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<(), Error>

Formats the value using the given formatter.

impl Default for Uuid

fn default() -> Uuid

Returns the “default value” for a type.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Uuid

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

Formats the value using the given formatter.

impl From<Uuid> for Binary

fn from(uuid: Uuid) -> Binary

Converts to this type from the input type.

impl From<Uuid> for Bson

fn from(u: Uuid) -> Bson

Converts to this type from the input type.

impl Hash for Uuid

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Uuid

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd 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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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 as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Uuid

impl Eq for Uuid

impl StructuralPartialEq for Uuid