Struct async_injector::Key

pub struct Key<T> where
    T: Any,  { /* fields omitted */ }

A key used to discriminate a value in the Injector.

Implementations

impl<T> Key<T> where
    T: Any, 

pub fn of() -> Self

Construct a new key without a tag.

Examples

use async_injector::Key;

struct Foo;

assert_eq!(Key::<Foo>::of(), Key::<Foo>::of());

pub fn tagged<K>(tag: K) -> Result<Self, Error> where
    K: Any + Serialize, 

Construct a new key.

Examples

use serde::Serialize;
use async_injector::Key;
use std::error::Error;

struct Foo;

#[derive(Serialize)]
enum Tag {
    One,
    Two,
}

#[derive(Serialize)]
enum Tag2 {
    One,
    Two,
}

assert_eq!(Key::<Foo>::tagged(Tag::One)?, Key::<Foo>::tagged(Tag::One)?);
assert_ne!(Key::<Foo>::tagged(Tag::One)?, Key::<Foo>::tagged(Tag::Two)?);
assert_ne!(Key::<Foo>::tagged(Tag::One)?, Key::<Foo>::tagged(Tag2::One)?);

Trait Implementations

impl<T> AsRef<Key<T>> for Key<T> where
    T: 'static, 

pub fn as_ref(&self) -> &Self

Performs the conversion.

impl<T: Clone> Clone for Key<T> where
    T: Any, 

pub fn clone(&self) -> Key<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Key<T> where
    T: Any, 

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

Formats the value using the given formatter.

impl<T> Eq for Key<T> where
    T: Any, 

impl<T> Hash for Key<T> where
    T: Any, 

pub fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T> Ord for Key<T> where
    T: Any, 

pub fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T> PartialEq<Key<T>> for Key<T> where
    T: Any, 

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> PartialOrd<Key<T>> for Key<T> where
    T: Any, 

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.