Struct NonNilUuid 

pub struct NonNilUuid(/* private fields */);

A UUID that is guaranteed not to be the nil UUID.

This is useful for representing optional UUIDs more efficiently, as Option<NonNilUuid> takes up the same space as Uuid.

Note that Uuids created by the following methods are guaranteed to be non-nil:

• [Uuid::new_v1]
• [Uuid::now_v1]
• [Uuid::new_v3]
• Uuid::new_v4
• Uuid::new_v5
• [Uuid::new_v6]
• [Uuid::now_v6]
• Uuid::new_v7
• Uuid::now_v7
• [Uuid::new_v8]

ABI

The NonNilUuid type does not yet have a stable ABI. Its representation or alignment may change. It is currently only guaranteed that NonNilUuid and Option<NonNilUuid> are the same size as Uuid.

Implementations

impl NonNilUuid

pub const fn new(uuid: Uuid) -> Option<Self>

Creates a non-nil UUID if the value is non-nil.

pub const unsafe fn new_unchecked(uuid: Uuid) -> Self

Creates a non-nil without checking whether the value is non-nil. This results in undefined behavior if the value is nil.

Safety

The value must not be nil.

pub const fn get(self) -> Uuid

Get the underlying Uuid value.

pub fn new_v4() -> Self

Creates a non-nil random version 4 UUID.

See Uuid::new_v4 for details.

pub fn new_v5(namespace: &Uuid, name: &[u8]) -> Self

Creates a non-nil version 5 UUID from a namespace and name.

See Uuid::new_v5 for details.

pub fn new_v7(ts: Timestamp) -> Self

Creates a non-nil version 7 UUID from a timestamp.

See Uuid::new_v7 for details.

pub fn now_v7() -> Self

Creates a non-nil version 7 UUID from the current time.

See Uuid::now_v7 for details.

Trait Implementations

impl Clone for NonNilUuid

fn clone(&self) -> NonNilUuid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NonNilUuid

impl Debug for NonNilUuid

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NonNilUuid

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NonNilUuid

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

Formats the value using the given formatter.

impl Eq for NonNilUuid

impl From<NonNilUuid> for Uuid

fn from(non_nil: NonNilUuid) -> Self

Converts a NonNilUuid back into a Uuid.

Examples

let uuid = Uuid::from_u128(0x0123456789abcdef0123456789abcdef);
let non_nil = NonNilUuid::try_from(uuid).unwrap();
let uuid_again = Uuid::from(non_nil);

assert_eq!(uuid, uuid_again);

impl Hash for NonNilUuid

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 Ord for NonNilUuid

fn cmp(&self, other: &NonNilUuid) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for NonNilUuid

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<NonNilUuid> for Uuid

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Uuid> for NonNilUuid

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for NonNilUuid

fn partial_cmp(&self, other: &NonNilUuid) -> 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 PartialOrd<NonNilUuid> for Uuid

fn partial_cmp(&self, other: &NonNilUuid) -> 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 PartialOrd<Uuid> for NonNilUuid

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 NonNilUuid

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 NonNilUuid

impl TryFrom<Uuid> for NonNilUuid

fn try_from(uuid: Uuid) -> Result<Self, Self::Error>

Attempts to convert a Uuid into a NonNilUuid.

Examples

let uuid = Uuid::from_u128(0x0123456789abcdef0123456789abcdef);
let non_nil = NonNilUuid::try_from(uuid).unwrap();

type Error = Error

The type returned in the event of a conversion error.