Struct Scru128Id 

pub struct Scru128Id(/* private fields */);

Time-sortable, 128-bit unique identifier used to order Frames.

Re-exported from the scru128 crate. Represents a SCRU128 ID and provides converters and comparison operators.

Examples

use scru128::Scru128Id;

let x = "036z968fu2tugy7svkfznewkk".parse::<Scru128Id>()?;
assert_eq!(x.to_string(), "036z968fu2tugy7svkfznewkk");

let y = Scru128Id::from(0x017fa1de51a80fd992f9e8cc2d5eb88eu128);
assert_eq!(y.to_u128(), 0x017fa1de51a80fd992f9e8cc2d5eb88eu128);

Implementations

impl Scru128Id

pub const fn from_u128(int_value: u128) -> Scru128Id

Creates an object from a 128-bit unsigned integer.

pub const fn to_u128(self) -> u128

Returns the 128-bit unsigned integer representation.

pub const fn from_bytes(array_value: [u8; 16]) -> Scru128Id

Creates an object from a 16-byte big-endian byte array.

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

Returns the big-endian byte array representation.

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

Returns a reference to the big-endian byte array representation.

pub const fn from_fields( timestamp: u64, counter_hi: u32, counter_lo: u32, entropy: u32, ) -> Scru128Id

Creates an object from field values.

Panics

Panics if any argument is out of the value range of the field.

pub const fn timestamp(&self) -> u64

Returns the 48-bit timestamp field value.

pub const fn counter_hi(&self) -> u32

Returns the 24-bit counter_hi field value.

pub const fn counter_lo(&self) -> u32

Returns the 24-bit counter_lo field value.

pub const fn entropy(&self) -> u32

Returns the 32-bit entropy field value.

pub const fn try_from_str(str_value: &str) -> Result<Scru128Id, ParseError>

Creates an object from a 25-digit string representation.

Examples

use scru128::Scru128Id;

let x = Scru128Id::try_from_str("037d0xye6op48cmce8ey4xlcf")?;
let y = "037d0xye6op48cmce8ey4xlcf".parse::<Scru128Id>()?;
assert_eq!(x, y);

pub const fn encode(&self) -> FStr<25>

Returns the 25-digit string representation stored in a stack-allocated string-like type that can be handled like String through common traits.

Examples

use scru128::Scru128Id;

let x = "037d0xye6op48cmce8ey4xlcf".parse::<Scru128Id>()?;
let y = x.encode();
assert_eq!(y, "037d0xye6op48cmce8ey4xlcf");
assert_eq!(format!("{}", y), "037d0xye6op48cmce8ey4xlcf");

Trait Implementations

impl AsRef<[u8]> for Scru128Id

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Scru128Id

fn clone(&self) -> Scru128Id

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Scru128Id

impl Debug for Scru128Id

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

Formats the value using the given formatter.

impl Default for Scru128Id

fn default() -> Scru128Id

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Scru128Id

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Scru128Id

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

Returns the 25-digit canonical string representation.

Examples

use scru128::Scru128Id;

let x = "03997ft3ckz99o1i3f82zat1t".parse::<Scru128Id>()?;
assert_eq!(format!("{}", x), "03997ft3ckz99o1i3f82zat1t");
assert_eq!(format!("{:32}", x), "03997ft3ckz99o1i3f82zat1t       ");
assert_eq!(format!("{:->32}", x), "-------03997ft3ckz99o1i3f82zat1t");
assert_eq!(format!("{:.^7.5}", x), ".03997.");

impl Eq for Scru128Id

impl From<Scru128Id> for [u8; 16]

fn from(object: Scru128Id) -> [u8; 16]

Returns the big-endian byte array representation.

impl From<Scru128Id> for String

fn from(object: Scru128Id) -> String

Converts to this type from the input type.

impl From<[u8; 16]> for Scru128Id

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

Creates an object from a 16-byte big-endian byte array.

impl From<u128> for Scru128Id

fn from(value: u128) -> Scru128Id

Converts to this type from the input type.

impl FromStr for Scru128Id

fn from_str(str_value: &str) -> Result<Scru128Id, <Scru128Id as FromStr>::Err>

Creates an object from a 25-digit string representation.

type Err = ParseError

The associated error which can be returned from parsing.

impl Hash for Scru128Id

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 Ord for Scru128Id

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

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

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

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 StructuralPartialEq for Scru128Id

impl TryFrom<String> for Scru128Id

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<Scru128Id, <Scru128Id as TryFrom<String>>::Error>

Performs the conversion.