Struct Key 

pub struct Key<F: Family> { /* private fields */ }

A handler key tagged with its effect family. Serializes as the underlying string without the family tag. Deserialization and Self::new_unchecked do not validate a registration; hosts must ensure the key serves F. Implements Send + Sync independently of F.

Implementations

impl<F: Family> Key<F>

pub const fn new_unchecked(raw: HandlerKey) -> Self

Assert that raw serves F. The one place a family is asserted rather than proven: for a host that registered the handler itself and knows what it serves. A wrong assertion fails at bind time (HandlerUnavailable) or at the first dispatch, not silently.

pub const fn raw(&self) -> &HandlerKey

The wire key.

pub fn into_raw(self) -> HandlerKey

The wire key, by value.

pub fn as_str(&self) -> &str

The key as a string.

Trait Implementations

impl<F: Family> AsRef<HandlerKey> for Key<F>

fn as_ref(&self) -> &HandlerKey

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

impl<F: Family> Clone for Key<F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Family> Debug for Key<F>

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

Formats the value using the given formatter.

impl<'de, F: Family> Deserialize<'de> for Key<F>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Family> Display for Key<F>

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

Formats the value using the given formatter.

impl<F: Family> Eq for Key<F>

impl<F: Family> From<Key<F>> for HandlerKey

fn from(key: Key<F>) -> Self

Converts to this type from the input type.

impl<F: Family> Hash for Key<F>

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<F: Family> Ord for Key<F>

fn cmp(&self, other: &Self) -> 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<F: Family> PartialEq for Key<F>

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

Equality operator ==.

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

Inequality operator !=.

impl<F: Family> PartialOrd for Key<F>

fn partial_cmp(&self, other: &Self) -> 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<F: Family> Serialize for Key<F>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.