Struct uhlc::ID

pub struct ID { /* fields omitted */ }

An identifier for an HLC (MAX_SIZE bytes maximum). This struct has a constant memory size (holding internally a [u8; MAX_SIZE] + a usize), allowing allocations on the stack for better performances.

Examples

use uhlc::ID;

let buf = [0x1a, 0x2b, 0x3c, 0x00, 0x00, 0x00, 0x00, 0x00,
           0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00];
let id = ID::new(3, buf);
assert_eq!(id.size(), 3);
assert_eq!(id.as_slice(), &[0x1a, 0x2b, 0x3c]);
assert_eq!(id.to_string(), "1A2B3C".to_string());

use uhlc::ID;
use uuid::Uuid;

let id = ID::from(Uuid::new_v4());
assert_eq!(id.size(), 16);

Implementations

impl ID

pub const MAX_SIZE: usize

The maximum size of an ID in bytes: 16.

pub fn new(size: usize, id: [u8; 16]) -> ID

Create a new ID with the "size" first bytes of "id"

pub fn size(&self) -> usize

The size of this ID in bytes

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

This ID as a slice

Trait Implementations

impl Clone for ID

fn clone(&self) -> ID

Returns a copy 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 Display for ID

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

Formats the value using the given formatter.

impl Eq for ID

impl From<Uuid> for ID

fn from(uuid: Uuid) -> Self

Performs the conversion.

impl FromStr for ID

type Err = ParseIDError

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 Hash for ID

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

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ID> for ID

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 PartialOrd<ID> for ID

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 StructuralEq for ID

impl<'_> TryFrom<&'_ [u8]> for ID

type Error = String

The type returned in the event of a conversion error.

fn try_from(slice: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.