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

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

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

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.

Trait Implementations

impl Clone for NonNilUuid

fn clone(&self) -> NonNilUuid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NonNilUuid

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

Formats the value using the given formatter.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NonNilUuid

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

Formats the value using the given formatter.

impl From<NonNilUuid> for Uuid

fn from(non_nil: NonNilUuid) -> Uuid

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>(&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 PartialEq<NonNilUuid> for Uuid

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

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

const 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 PartialEq<Uuid> for NonNilUuid

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

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

const 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 PartialEq for NonNilUuid

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

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

const 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 Serialize for NonNilUuid

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 TryFrom<Uuid> for NonNilUuid

fn try_from( uuid: Uuid, ) -> Result<NonNilUuid, <NonNilUuid as TryFrom<Uuid>>::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.

impl Copy for NonNilUuid

impl Eq for NonNilUuid

impl StructuralPartialEq for NonNilUuid