Struct LogicalKey 

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

The application’s identifier for one logical occurrence of an effect, e.g. the order id for payment.charge.

Implementations

impl LogicalKey

pub fn new(key: impl Into<String>) -> Result<LogicalKey, IdentityError>

Validates and wraps a key.

Errors

Rejects empty keys, keys over MAX_KEY_LEN bytes and keys containing control characters.

pub fn as_str(&self) -> &str

The key as a string slice.

Trait Implementations

impl Clone for LogicalKey

fn clone(&self) -> LogicalKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogicalKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LogicalKey

fn deserialize<__D>( __deserializer: __D, ) -> Result<LogicalKey, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LogicalKey

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

Formats the value using the given formatter.

impl Eq for LogicalKey

impl Hash for LogicalKey

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 LogicalKey

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for LogicalKey

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LogicalKey

impl TryFrom<String> for LogicalKey

type Error = IdentityError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<LogicalKey, <LogicalKey as TryFrom<String>>::Error>

Performs the conversion.