Struct StoreId 

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

A validated store identifier.

A newtype rather than a bare String so that the validation cannot be skipped: the inner field is private and StoreId::new is the only way in, which makes “this store id cannot break the cause encoding” a property of the type instead of a convention callers are asked to remember.

Implementations

impl StoreId

pub fn new(s: impl Into<String>) -> Result<StoreId, StoreIdError>

Validate and construct.

Refuses anything that would make a cause reference ambiguous, unparseable, or unsafe as a path component. See StoreIdError.

pub fn as_str(&self) -> &str

Borrow the underlying string.

pub fn into_string(self) -> String

Consume and return the underlying string.

Trait Implementations

impl AsRef<str> for StoreId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for StoreId

fn clone(&self) -> StoreId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoreId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StoreId

fn deserialize<D>(d: D) -> Result<StoreId, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StoreId

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

Formats the value using the given formatter.

impl Eq for StoreId

impl FromStr for StoreId

type Err = StoreIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<StoreId, <StoreId as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for StoreId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 StoreId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StoreId

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

fn serialize<S>( &self, s: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StoreId