Enum Uid 

pub enum Uid {
    Singleton(Label),
    Instance(u64, Option<Label>),
}

A unique identifier.

Singleton labels are identity. Instance labels are supplemental metadata and do not participate in equality, hashing, or ordering.

Variants

Singleton(Label)

A singleton identified by label.

Instance(u64, Option<Label>)

An instance identified by a random u64, with an optional display label.

Implementations

impl Uid

pub fn is_singleton(&self) -> bool

Returns true if this is a Uid::Singleton, otherwise false

pub fn as_singleton_mut(&mut self) -> Option<&mut Label>

Optionally returns mutable references to the inner fields if this is a Uid::Singleton, otherwise None

pub fn as_singleton(&self) -> Option<&Label>

Optionally returns references to the inner fields if this is a Uid::Singleton, otherwise None

pub fn into_singleton(self) -> Result<Label, Self>

Returns the inner fields if this is a Uid::Singleton, otherwise returns back the enum in the Err case of the result

pub fn is_instance(&self) -> bool

Returns true if this is a Uid::Instance, otherwise false

pub fn as_instance_mut(&mut self) -> Option<(&mut u64, &mut Option<Label>)>

Optionally returns mutable references to the inner fields if this is a Uid::Instance, otherwise None

pub fn as_instance(&self) -> Option<(&u64, &Option<Label>)>

Optionally returns references to the inner fields if this is a Uid::Instance, otherwise None

pub fn into_instance(self) -> Result<(u64, Option<Label>), Self>

Returns the inner fields if this is a Uid::Instance, otherwise returns back the enum in the Err case of the result

impl Uid

pub fn anonymous() -> Self

Create a fresh instance with a random uid and no display label.

pub fn instance(label: Label) -> Self

Create a fresh instance with a random uid and display label.

pub fn singleton(label: Label) -> Self

Create a singleton with the given label.

pub fn label(&self) -> Option<&Label>

Returns the display label for this uid, if present.

For singletons, the label is the identity. For instances, the label is supplemental metadata.

pub fn instance_uid_base58(&self) -> Option<String>

Returns the raw base58 uid for instances, without display delimiters.

pub fn parse_instance_uid_base58(s: &str) -> Result<u64, UidParseError>

Parses a raw base58 uid for instances, without display delimiters.

pub fn with_label(self, label: Option<Label>) -> Self

Returns this uid with the provided instance label.

Singleton labels are identity and are not replaced.

Trait Implementations

impl Clone for Uid

fn clone(&self) -> Uid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Uid

Displays as label (singleton), label<base58> (labeled instance), or <base58> (unlabeled instance).

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Uid

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

Deserialize this value from the given Serde deserializer.

impl Display for Uid

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

Formats the value using the given formatter.

impl FromStr for Uid

Parses label as singleton, <base58> as an unlabeled instance, and label<base58> as a labeled instance.

type Err = UidParseError

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 Hash for Uid

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 Uid

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 PartialEq for Uid

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 PartialOrd for Uid

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 Serialize for Uid

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

Serialize this value into the given Serde serializer.

impl Eq for Uid