Struct StateBase

pub struct StateBase<Q, K> { /* private fields */ }

StateBase is an abstract object that allows a particular kind of state to be associated with some generic state Q

Implementations

impl<K, Q> StateBase<Q, K>

where K: RawStateKind,

pub const fn new(state: Q) -> Self

returns a new instance of StateBase with the given value

pub fn new_with<F>(f: F) -> Self

where F: FnOnce() -> Q,

returns a new instance of StateBase using the output of the given function F

pub fn default() -> Self

where Q: Default,

returns a new instance of StateBase using the logical default for the type Q

pub const fn get(&self) -> &Q

returns a reference to the state

pub const fn get_mut(&mut self) -> &mut Q

returns a mutable reference to the state

pub fn is_kind<R>(&self) -> bool

where R: 'static,

returns true if the state is of the specified kind

Trait Implementations

impl<Q: Clone, K: Clone> Clone for StateBase<Q, K>

fn clone(&self) -> StateBase<Q, K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q: Debug, K: Debug> Debug for StateBase<Q, K>

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

Formats the value using the given formatter.

impl<Q: Default, K: Default> Default for StateBase<Q, K>

fn default() -> StateBase<Q, K>

Returns the “default value” for a type.

impl<'de, Q, K> Deserialize<'de> for StateBase<Q, K>

where StateBase<Q, K>: Default, Q: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Q: Hash, K: Hash> Hash for StateBase<Q, K>

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<Q: Ord, K: Ord> Ord for StateBase<Q, K>

fn cmp(&self, other: &StateBase<Q, K>) -> 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<Q: PartialEq, K: PartialEq> PartialEq for StateBase<Q, K>

fn eq(&self, other: &StateBase<Q, K>) -> 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<Q: PartialOrd, K: PartialOrd> PartialOrd for StateBase<Q, K>

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

where Q: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Q, K> StateRepr for StateBase<Q, K>

where Q: RawState,

type Item = Q

impl<Q: Copy, K: Copy> Copy for StateBase<Q, K>

impl<Q: Eq, K: Eq> Eq for StateBase<Q, K>

impl<Q, K> StructuralPartialEq for StateBase<Q, K>