Struct ValueCodecId 

pub struct ValueCodecId(/* private fields */);

A validated, process-independent value-codec identifier.

Examples

use qubit_codec::ValueCodecId;

let id = ValueCodecId::new("example.u16");
assert_eq!(id.as_str(), "example.u16");

Implementations

impl ValueCodecId

pub const fn new(value: &'static str) -> Self

Creates an ID from a static string.

Panics

Panics when value violates the point-separated ASCII protocol.

pub const fn try_new(value: &'static str) -> Result<Self, ValueCodecIdError>

Validates and creates an ID.

Errors

Returns the exact stable-ID protocol violation.

pub const fn as_str(self) -> &'static str

Returns the complete stable ID.

Trait Implementations

impl Borrow<str> for ValueCodecId

fn borrow(&self) -> &str

Borrows the stable identifier for lookup without allocating.

impl Clone for ValueCodecId

fn clone(&self) -> ValueCodecId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ValueCodecId

impl Debug for ValueCodecId

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

Formats the value using the given formatter.

impl Eq for ValueCodecId

impl Hash for ValueCodecId

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ValueCodecId

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for ValueCodecId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ValueCodecId

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