Struct Sulid 

pub struct Sulid { /* private fields */ }

A “signed” ULID, whose “random” portion is generated by a cryptographic signature.

Implementations

impl Sulid

pub fn sign(secret: &SigningKey, payload: UnsignedPayload) -> SignedPayload

Create a new sULID by signing a payload.

Returns a SignedPayload which includes the generated Sulid, as well as the payload parts required to verify it.

The SignedPayload generated by this function is guaranteed to be valid. However, to validate untrusted sULIDs, you can construct a SignedPayload and call its is_valid().

pub fn timestamp(&self) -> SystemTime

Gets the timestamp portion of the sULID from the first 48 bits.

pub fn to_bytes(&self) -> [u8; 16]

Trait Implementations

impl Clone for Sulid

fn clone(&self) -> Sulid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Sulid

impl Debug for Sulid

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

Formats the value using the given formatter.

impl Display for Sulid

Provides the canonical .to_string() form of sULIDs

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

Formats the value using the given formatter.

impl Eq for Sulid

impl From<[u8; 16]> for Sulid

fn from(value: [u8; 16]) -> Self

Converts to this type from the input type.

impl FromStr for Sulid

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

Note: This only parses/deserializes an sULID from its string representation. To verify that it has not been tampered with, check it using SignedPayload::is_valid()

type Err = DecodeError

The associated error which can be returned from parsing.

impl Hash for Sulid

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 Sulid

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Sulid

fn partial_cmp(&self, other: &Sulid) -> 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 StructuralPartialEq for Sulid