Struct Id

pub struct Id { /* private fields */ }

The Id is an identifier for an entity or part of an entity

Implementations

impl Id

pub fn from_hex(buffer: &[u8]) -> Result<Self, Error>

Parse the buffer as a sequence of hex bytes from which to decode use.

Note

This means that the length of the buffer must be 64.

Errors

This will return an error, if the buffer cannot be interpreted as sequence of hex bytes, or is too long/short.

pub fn as_slice(&self) -> &[u8]

Return the raw byte slice representing this Id.

pub fn hex_to_buf<'a>(&self, buf: &'a mut [u8]) -> &'a mut str

Write ourselves to the out in hexadecimal notation, returning the hex-string ready for display.

Panics

If the buffer isn’t big enough to hold twice as many bytes as stored (32

• 2).

pub fn shorten(&self) -> IdPrefix

Shorten an Id to the required length, so that it stays unique, but is still short enough for human consumption.

pub fn combine_with(self, other: Id) -> CombinedId

Combine this id with another Id.

This is useful, if you want to get a shorten prefix that can be used to direct to a comment (for example).

Note

The underlying algorithm assumes that there are more Ids for the type of self than for other.

Trait Implementations

impl Clone for Id

fn clone(&self) -> Id

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Id

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Id

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

Formats the value using the given formatter.

impl From<Id> for IdPrefix

fn from(value: Id) -> Self

Converts to this type from the input type.

impl From<Id> for String

fn from(value: Id) -> Self

Converts to this type from the input type.

impl FromStr for Id

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

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Id

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Id

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Id

impl Eq for Id

impl StructuralPartialEq for Id