Struct Kind

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

Kind describes the type of entity represented by a Context. The meaning of a kind is entirely up to the application. To construct a custom kind other than “user”, see Kind::try_from.

Implementations

impl Kind

pub fn is_user(&self) -> bool

Returns true if the kind is “user”. Users are the default context kind created by crate::ContextBuilder.

pub fn is_multi(&self) -> bool

Returns true if the kind is “multi”. Multi-contexts are created by crate::MultiContextBuilder.

pub fn user() -> Self

Constructs a kind of type “user”. See also Kind::try_from to create a custom kind, which may then be passed to crate::ContextBuilder::kind.

Trait Implementations

impl AsRef<str> for Kind

fn as_ref(&self) -> &str

Returns a reference to the kind’s underlying string.

impl Clone for Kind

fn clone(&self) -> Kind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Kind

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

Formats the value using the given formatter.

impl Default for Kind

fn default() -> Self

Kind defaults to “user”.

impl<'de> Deserialize<'de> for Kind

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Kind

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

Displays the string representation of a kind.

impl From<Kind> for String

fn from(k: Kind) -> Self

Converts a kind into its string representation.

impl Hash for Kind

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 Kind

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.

impl PartialEq<&str> for Kind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for Kind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Kind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Kind

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 Serialize for Kind

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Kind

fn try_from(value: &str) -> Result<Self, Self::Error>

Fallibly constructs a kind from a string reference. See Kind::try_from.

type Error = String

The type returned in the event of a conversion error.

impl TryFrom<String> for Kind

fn try_from(value: String) -> Result<Self, Self::Error>

Fallibly constructs a kind from an owned string. To be a valid kind, the value cannot be empty or equal to “kind”. Additionally, it must be composed entirely of ASCII alphanumeric characters, in addition to -, . and _.

type Error = String

The type returned in the event of a conversion error.

impl Eq for Kind

impl StructuralPartialEq for Kind