Struct avocado::uid::Uid

pub struct Uid<T: Doc>(_);

A newtype wrapper to provide type safety for unique IDs of Documents that share the same underlying raw ID type.

It serializes and deserializes transparently as if it were a value of type <T as Doc>::Id.

Methods

impl<T: Doc> Uid<T>

pub fn from_raw(raw: T::Id) -> Self

Creates a strongly-typed Uid<T> from a raw representation.

pub fn into_raw(self) -> T::Id

Converts the strongly-typed Uid<T> into its raw representation.

impl<T: Doc<Id = ObjectId>> Uid<T>

Convenience methods for ObjectId-valued Uids.

pub fn new_oid() -> Result<Self, Error>

Generates a new ObjectId-valued unique ID.

pub fn from_oid_bytes(bytes: [u8; 12]) -> Self

Constructs a wrapper around an ObjectId represented by raw bytes.

pub fn from_oid_str(s: &str) -> Result<Self, Error>

Creates an ObjectID-valued Uid using a 12-byte (24-char) hexadecimal string.

impl<T: Doc<Id = Uuid>> Uid<T>

Convenience methods for Uuid-valued Uids.

pub fn new_uuid() -> Self

Creates a new random (v4) UUID-backed ID.

pub fn from_uuid_bytes(bytes: [u8; 16]) -> Self

Creates a Uid backed by a Uuid of the exact bytes specified.

pub fn from_random_uuid_bytes(bytes: [u8; 16]) -> Self

Creates a Uid backed by a Uuid based on the bytes supplied, modified so that the result is a valid v4 variant.

Trait Implementations

impl<T: Doc> Ord for Uid<T> where     T::Id: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl<T: Doc> PartialEq<Uid<T>> for Uid<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Doc> From<Uid<T>> for Bson where     T::Id: Into<Bson>,

fn from(uid: Uid<T>) -> Self

Performs the conversion.

impl<T: Doc, '_> From<&'_ Uid<T>> for Bson where     T::Id: ToOwned,     <T::Id as ToOwned>::Owned: Into<Bson>,

fn from(uid: &Uid<T>) -> Self

Performs the conversion.

impl<T: Doc> Clone for Uid<T> where     T::Id: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Doc> Copy for Uid<T> where     T::Id: Copy,

impl<T: Doc> Eq for Uid<T>

impl<T: Doc> PartialOrd<Uid<T>> for Uid<T> where     T::Id: PartialOrd,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Doc> AsRef<<T as Doc>::Id> for Uid<T>

fn as_ref(&self) -> &T::Id

Performs the conversion.

impl<T: Doc> Default for Uid<T> where     T::Id: Default,

fn default() -> Self

Returns the "default value" for a type.

impl<T: Doc> Display for Uid<T> where     T::Id: Display,

fn fmt(&self, formatter: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl<T: Doc> Debug for Uid<T> where     T::Id: Debug,

fn fmt(&self, formatter: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl<T: Doc> FromStr for Uid<T> where     T::Id: FromStr,

type Err = <T::Id as FromStr>::Err

The associated error which can be returned from parsing.

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

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

impl<T: Doc> Hash for Uid<T> where     T::Id: Hash,

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,

Feeds a slice of this type into the given [Hasher].

impl<'a, T: Doc> Deserialize<'a> for Uid<T>

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

Deserialize this value from the given Serde deserializer.

impl<T: Doc> Serialize for Uid<T>

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

Serialize this value into the given Serde serializer.

impl<T: Doc> BsonSchema for Uid<T> where     T::Id: BsonSchema,

fn bson_schema() -> Document

Returns a BSON document describing the MongoDB-flavored schema of this type.