Struct alphaid::AlphaId

pub struct AlphaId<T: UnsignedInteger = u128> { /* fields omitted */ }

Used for encoding and decoding.

Implementations

impl<T: UnsignedInteger> AlphaId<T>

pub fn builder() -> Builder<T>

Returns a builder type to configure a new AlphaId.

pub fn new() -> Self

Creates a new AlphaId with a default configuration.

pub fn encode(&self, n: T) -> Result<Vec<u8>, AlphaIdError>

Encode the numbers.

Example

use alphaid::AlphaId;

let alphaid = AlphaId::<u32>::new();
assert_eq!(alphaid.encode(0), Ok(b"a".to_vec()));
assert_eq!(alphaid.encode(1), Ok(b"b".to_vec()));
assert_eq!(alphaid.encode(1350997667), Ok(b"90F7qb".to_vec()));

pub fn decode<V: AsRef<[u8]>>(&self, v: V) -> Result<T, AlphaIdError>

Decode into numbers.

Example

use alphaid::AlphaId;

let alphaid = AlphaId::<u32>::new();
assert_eq!(alphaid.decode(b"a"), Ok(0));
assert_eq!(alphaid.decode(b"b"), Ok(1));
assert_eq!(alphaid.decode(b"90F7qb"), Ok(1350997667));