Struct uhlc::ID

pub struct ID(_);

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

Examples

use std::convert::TryFrom;
use uhlc::ID;

let buf = [0x1a, 0x2b, 0x3c, 0x00, 0x00, 0x00, 0x00, 0x00,
           0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00];
let id = ID::try_from(&buf[..3]).unwrap();
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 = 16usize

The maximum size of an ID in bytes: 16.

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<'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<Uuid> for ID

fn from(uuid: Uuid) -> Self

Converts to this type from the input type.

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.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<ID> for ID

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ID) -> 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.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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 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<&[u8; 1]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 10]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 11]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 12]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 13]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 14]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 15]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 16]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 2]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 3]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 4]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 5]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 6]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 7]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 8]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 9]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<[u8; 1]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 1]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 10]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 10]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 11]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 11]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 12]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 12]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 13]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 13]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 14]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 14]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 15]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 15]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 16]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 16]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 2]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 2]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 3]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 3]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 4]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 4]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 5]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 5]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 6]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 6]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 7]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 7]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 8]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 9]> for ID

type Error = SizeError

The type returned in the event of a conversion error.

fn try_from(id: [u8; 9]) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ID

impl Eq for ID

impl StructuralEq for ID

impl StructuralPartialEq for ID