Struct TypedUuid

pub struct TypedUuid<T: TypedUuidKind> { /* private fields */ }

A UUID with type-level information about what it’s used for.

For more, see the library documentation.

Implementations

impl<T: TypedUuidKind> TypedUuid<T>

pub const fn nil() -> Self

The ‘nil UUID’ (all zeros).

The nil UUID is a special form of UUID that is specified to have all 128 bits set to zero.

References

• Nil UUID in RFC4122

pub const fn max() -> Self

The ‘max UUID’ (all ones).

The max UUID is a special form of UUID that is specified to have all 128 bits set to one.

References

• Max UUID in Draft RFC: New UUID Formats, Version 4

pub const fn from_fields(d1: u32, d2: u16, d3: u16, d4: [u8; 8]) -> Self

Creates a UUID from four field values.

pub const fn from_fields_le(d1: u32, d2: u16, d3: u16, d4: [u8; 8]) -> Self

Creates a UUID from four field values in little-endian order.

The bytes in the d1, d2 and d3 fields will be flipped to convert into big-endian order. This is based on the endianness of the UUID, rather than the target environment so bytes will be flipped on both big and little endian machines.

pub const fn from_u128(value: u128) -> Self

Creates a UUID from a 128bit value.

pub const fn from_u128_le(value: u128) -> Self

Creates a UUID from a 128bit value in little-endian order.

The entire value will be flipped to convert into big-endian order. This is based on the endianness of the UUID, rather than the target environment so bytes will be flipped on both big and little endian machines.

pub const fn from_u64_pair(d1: u64, d2: u64) -> Self

Creates a UUID from two 64bit values.

pub const fn from_bytes(bytes: Bytes) -> Self

Creates a UUID using the supplied bytes.

pub const fn from_bytes_le(bytes: Bytes) -> Self

Creates a UUID using the supplied bytes in little-endian order.

The individual fields encoded in the buffer will be flipped.

pub fn new_v4() -> Self

Available on crate feature v4 only.

Creates a new, random UUID v4 of this type.

Trait Implementations

impl<T: TypedUuidKind> Clone for TypedUuid<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: TypedUuidKind> Debug for TypedUuid<T>

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

Formats the value using the given formatter.

impl<T: TypedUuidKind> Default for TypedUuid<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: TypedUuidKind> Deserialize<'de> for TypedUuid<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: TypedUuidKind> Display for TypedUuid<T>

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

Formats the value using the given formatter.

impl<T: TypedUuidKind> FromStr for TypedUuid<T>

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T: TypedUuidKind> GenericUuid for TypedUuid<T>

fn from_untyped_uuid(uuid: Uuid) -> Self

Creates a new instance of Self from an untyped Uuid.

fn into_untyped_uuid(self) -> Uuid

Converts self into an untyped Uuid.

fn as_untyped_uuid(&self) -> &Uuid

Returns the inner Uuid.

impl<T: TypedUuidKind> Hash for TypedUuid<T>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> JsonSchema for TypedUuid<T>

where T: TypedUuidKind + JsonSchema,

Available on crate feature schemars08 only.

Implements JsonSchema for TypedUuid<T>, if T implements JsonSchema.

• schema_name is set to "TypedUuidFor", concatenated by the schema name of T.
• schema_id is set to format!("newtype_uuid::TypedUuid<{}>", T::schema_id()).
• json_schema is the same as the one for Uuid.

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T: TypedUuidKind> Ord for TypedUuid<T>

fn cmp(&self, other: &Self) -> 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<T: TypedUuidKind> PartialEq for TypedUuid<T>

fn eq(&self, other: &Self) -> 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<T: TypedUuidKind> PartialOrd for TypedUuid<T>

fn partial_cmp(&self, other: &Self) -> 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<T: TypedUuidKind> Serialize for TypedUuid<T>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: TypedUuidKind> Copy for TypedUuid<T>

impl<T: TypedUuidKind> Eq for TypedUuid<T>