Struct Oid

pub struct Oid<P> { /* private fields */ }

A Typed Object ID where the Prefix is part of the type

Examples

A nice property of this two different prefix are two different types, and thus the following fails to compile:

struct A;
impl OidPrefix for A {}

struct B;
impl OidPrefix for B {}

// The same UUID for both
let oid_a: Oid<A> = Oid::try_with_uuid("b3cfdafa-3fec-41e2-82bf-ff881131abf1").unwrap();
let oid_b: Oid<B> = Oid::try_with_uuid("b3cfdafa-3fec-41e2-82bf-ff881131abf1").unwrap();

// This fails to compile because `Oid<A>` is a different type than `Oid<B>` and no
// PartialEq or Eq is implemented between these two types.
oid_a == oid_b

Implementations

impl<P: OidPrefix> Oid<P>

pub fn new_v4() -> Self

Available on crate feature uuid_v4 only.

Create a new Oid with a UUIDv4 (random)

pub fn new_v7_now() -> Self

Available on crate feature uuid_v7 only.

Create a new Oid with a UUIDv7 (UNIX Epoch based for current system clock)

pub fn new_v7(ts: Timestamp) -> Self

Available on crate feature uuid_v7 only.

Create a new Oid with a UUIDv7 (UNIX Epoch based)

pub fn with_uuid(uuid: Uuid) -> Self

Create a new Oid with a given UUID

pub fn try_with_uuid<S: AsRef<str>>(uuid: S) -> Result<Self>

Attempts to create a new Oid with a given string-ish UUID

pub fn try_with_uuid_base32<S: AsRef<str>>(base32_uuid: S) -> Result<Self>

Attemp to create an Oid from a base32hex encoded UUID string-ish value

pub fn prefix(&self) -> Prefix

Get the Prefix of the TOID

Panics

If the Type P translates to an invalid prefix

pub fn value(&self) -> String

Get the value portion of the of the TOID, which is the base32 encoded string following the - separator

pub fn uuid(&self) -> &Uuid

Get the UUID of the TOID

Trait Implementations

impl<P> Clone for Oid<P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Debug for Oid<P>

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

Formats the value using the given formatter.

impl<'de, P: OidPrefix> Deserialize<'de> for Oid<P>

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P: OidPrefix> Display for Oid<P>

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

Formats the value using the given formatter.

impl<P: OidPrefix> FromStr for Oid<P>

type Err = Error

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<P> Hash for Oid<P>

where P: OidPrefix,

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<P: PartialEq> PartialEq for Oid<P>

fn eq(&self, other: &Oid<P>) -> 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<P: OidPrefix> Serialize for Oid<P>

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<P: OidPrefix> TryFrom<Thing> for Oid<P>

Available on crate feature surrealdb only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(thing: Thing) -> Result<Self>

Performs the conversion.

impl<P> Copy for Oid<P>

impl<P: Eq> Eq for Oid<P>

impl<P> StructuralPartialEq for Oid<P>