Struct HexPrefix

pub struct HexPrefix { /* private fields */ }

An identifier prefix (typically from a type implementing the ObjectId trait) with facilities for converting between bytes and a hex string.

Implementations

impl HexPrefix

pub fn try_from_hex(prefix: &str) -> Option<HexPrefix>

Returns a new HexPrefix or None if prefix cannot be decoded from hex to bytes.

pub fn try_from_reverse_hex(prefix: &str) -> Option<HexPrefix>

Returns a new HexPrefix or None if prefix cannot be decoded from “reverse” hex to bytes.

pub fn from_bytes(bytes: &[u8]) -> Self

pub fn from_id<T: ObjectId + ?Sized>(id: &T) -> Self

Returns a new HexPrefix representing the given id.

pub fn hex(&self) -> String

Returns string representation of this prefix using hex digits.

pub fn reverse_hex(&self) -> String

Returns string representation of this prefix using z-k “digits”.

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

Minimum bytes that would match this prefix. (e.g. “abc0” for “abc”)

Use this to partition a sorted slice, and test matches(id) from there.

pub fn as_full_bytes(&self) -> Option<&[u8]>

Returns the bytes representation if this prefix can be a full id.

pub fn matches<Q: ObjectId>(&self, id: &Q) -> bool

Returns whether the stored prefix matches the prefix of id.

Trait Implementations

impl Clone for HexPrefix

fn clone(&self) -> HexPrefix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HexPrefix

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

Formats the value using the given formatter.

impl PartialEq for HexPrefix

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

Tests for self and other values to be equal, and is used by ==.

const 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 Eq for HexPrefix

impl StructuralPartialEq for HexPrefix