Struct State 

#[repr(transparent)]
pub struct State<Q = usize>(pub Q)
where
    Q: ?Sized;

State is generic over some type Q that implements the RawState trait.

Tuple Fields

0: Q

Implementations

impl<Q> State<Q>

where Q: RawState,

generic implementation of the State type available for all types Q

pub const fn new(state: Q) -> State<Q>

returns a new instance of State with the given value

pub fn new_with<F>(f: F) -> State<Q>

where F: FnOnce() -> Q,

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

pub fn default() -> State<Q>

where Q: Default,

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

pub fn one() -> State<Q>

where Q: One,

returns a new instance of State with an inner value of 1

pub fn zero() -> State<Q>

where Q: Zero,

returns a new instance of State with an inner value of 0

pub fn random() -> State<Q>

where StandardUniform: Distribution<Q>,

generate a new instance of the state with a random value

pub fn random_with<R, Dist>(rng: &mut R, distr: Dist) -> State<Q>

where Dist: Distribution<Q>, R: RngCore,

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

returns an immutable reference to the inner value

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

returns a mutable reference to the inner value

pub fn value(self) -> Q

consumes the current instance to return the inner value

pub const fn replace(&mut self, state: Q) -> Q

replace the inner state with the given value and return the previous

pub fn set(&mut self, state: Q)

mutate the inner value in-place, updating it with the given state

pub const fn swap(&mut self, state: &mut State<Q>)

swap the inner value with that of another state instance of the same type Q

pub fn take(&mut self) -> Q

where Q: Default,

takes the inner value and replaces it with the default value

pub fn with<U>(self, value: U) -> State<U>

consumes the current instance to replace it with another.

pub fn map<U, F>(self, f: F) -> State<U>

where F: FnOnce(Q) -> U,

apply a function onto the inner value and return a new instance with the result

pub fn map_inplace<F>(&mut self, f: F) -> &mut State<Q>

where F: FnOnce(&mut Q),

updates the inner value using the given function and returns a mutable reference to the current instance for chaining

pub const fn view(&self) -> State<&Q>

returns a new instance containing a reference to the inner value

pub const fn view_mut(&mut self) -> State<&mut Q>

returns a new instance containing a mutable reference to the inner value

impl<Q> State<&Q>

where Q: RawState,

pub fn cloned(&self) -> State<Q>

where Q: Clone,

returns a new state with a cloned inner value

pub fn copied(&self) -> State<Q>

where Q: Copy,

returns a new state with the inner value copied

impl<Q> State<&mut Q>

where Q: RawState,

pub fn cloned(&self) -> State<Q>

where Q: Clone,

returns a new state with a cloned inner value

pub fn copied(&self) -> State<Q>

where Q: Copy,

returns a new state with the inner value copied

impl<Q> State<MaybeUninit<Q>>

where Q: RawState,

pub fn uninit() -> State<MaybeUninit<Q>>

returns a new state with an uninitialized inner state

pub fn init(value: Q) -> State<MaybeUninit<Q>>

returns a new state with an initialized inner state

impl<Q> State<Option<Q>>

where Q: RawState,

pub fn none() -> State<Option<Q>>

returns a new state with a None inner state

pub fn some(value: Q) -> State<Option<Q>>

returns a new instance with some inner state

pub fn is_none(&self) -> bool

returns true if the inner state is None

pub fn is_some(&self) -> bool

returns true if the inner state is Some

Trait Implementations

impl<'a, _A, _B, _C> Add<&'a State<_B>> for &'a State<_A>

where &'a _A: Add<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the + operator.

fn add( self, rhs: &'a State<_B>, ) -> <&'a State<_A> as Add<&'a State<_B>>>::Output

Performs the + operation.

impl<'a, _A, _B, _C> Add<&'a State<_B>> for State<_A>

where _A: Add<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the + operator.

fn add(self, rhs: &'a State<_B>) -> <State<_A> as Add<&'a State<_B>>>::Output

Performs the + operation.

impl<'a, _A, _B, _C> Add<&'a mut State<_B>> for &'a mut State<_A>

where &'a mut _A: Add<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the + operator.

fn add( self, rhs: &'a mut State<_B>, ) -> <&'a mut State<_A> as Add<&'a mut State<_B>>>::Output

Performs the + operation.

impl<'a, _A, _B, _C> Add<&'a mut State<_B>> for State<_A>

where _A: Add<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the + operator.

fn add( self, rhs: &'a mut State<_B>, ) -> <State<_A> as Add<&'a mut State<_B>>>::Output

Performs the + operation.

impl<'a, _A, _B, _C> Add<State<_B>> for &'a State<_A>

where &'a _A: Add<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the + operator.

fn add(self, rhs: State<_B>) -> <&'a State<_A> as Add<State<_B>>>::Output

Performs the + operation.

impl<'a, _A, _B, _C> Add<State<_B>> for &'a mut State<_A>

where &'a mut _A: Add<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the + operator.

fn add(self, rhs: State<_B>) -> <&'a mut State<_A> as Add<State<_B>>>::Output

Performs the + operation.

impl<_A, _B, _C> Add<State<_B>> for State<_A>

where _A: Add<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the + operator.

fn add(self, rhs: State<_B>) -> <State<_A> as Add<State<_B>>>::Output

Performs the + operation.

impl<_A, _B> AddAssign<State<_B>> for State<_A>

where _A: AddAssign<_B>,

fn add_assign(&mut self, rhs: State<_B>)

Performs the += operation.

impl<Q> AsMut<Q> for State<Q>

where Q: RawState,

fn as_mut(&mut self) -> &mut Q

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

impl<Q> AsRef<Q> for State<Q>

where Q: RawState,

fn as_ref(&self) -> &Q

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

impl<Q> Binary for State<Q>

where Q: Binary,

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

Formats the value using the given formatter.

impl<'a, _A, _B, _C> BitAnd<&'a State<_B>> for &'a State<_A>

where &'a _A: BitAnd<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the & operator.

fn bitand( self, rhs: &'a State<_B>, ) -> <&'a State<_A> as BitAnd<&'a State<_B>>>::Output

Performs the & operation.

impl<'a, _A, _B, _C> BitAnd<&'a State<_B>> for State<_A>

where _A: BitAnd<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the & operator.

fn bitand( self, rhs: &'a State<_B>, ) -> <State<_A> as BitAnd<&'a State<_B>>>::Output

Performs the & operation.

impl<'a, _A, _B, _C> BitAnd<&'a mut State<_B>> for &'a mut State<_A>

where &'a mut _A: BitAnd<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the & operator.

fn bitand( self, rhs: &'a mut State<_B>, ) -> <&'a mut State<_A> as BitAnd<&'a mut State<_B>>>::Output

Performs the & operation.

impl<'a, _A, _B, _C> BitAnd<&'a mut State<_B>> for State<_A>

where _A: BitAnd<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the & operator.

fn bitand( self, rhs: &'a mut State<_B>, ) -> <State<_A> as BitAnd<&'a mut State<_B>>>::Output

Performs the & operation.

impl<'a, _A, _B, _C> BitAnd<State<_B>> for &'a State<_A>

where &'a _A: BitAnd<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the & operator.

fn bitand(self, rhs: State<_B>) -> <&'a State<_A> as BitAnd<State<_B>>>::Output

Performs the & operation.

impl<'a, _A, _B, _C> BitAnd<State<_B>> for &'a mut State<_A>

where &'a mut _A: BitAnd<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the & operator.

fn bitand( self, rhs: State<_B>, ) -> <&'a mut State<_A> as BitAnd<State<_B>>>::Output

Performs the & operation.

impl<_A, _B, _C> BitAnd<State<_B>> for State<_A>

where _A: BitAnd<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the & operator.

fn bitand(self, rhs: State<_B>) -> <State<_A> as BitAnd<State<_B>>>::Output

Performs the & operation.

impl<_A, _B> BitAndAssign<State<_B>> for State<_A>

where _A: BitAndAssign<_B>,

fn bitand_assign(&mut self, rhs: State<_B>)

Performs the &= operation.

impl<'a, _A, _B, _C> BitOr<&'a State<_B>> for &'a State<_A>

where &'a _A: BitOr<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the | operator.

fn bitor( self, rhs: &'a State<_B>, ) -> <&'a State<_A> as BitOr<&'a State<_B>>>::Output

Performs the | operation.

impl<'a, _A, _B, _C> BitOr<&'a State<_B>> for State<_A>

where _A: BitOr<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the | operator.

fn bitor( self, rhs: &'a State<_B>, ) -> <State<_A> as BitOr<&'a State<_B>>>::Output

Performs the | operation.

impl<'a, _A, _B, _C> BitOr<&'a mut State<_B>> for &'a mut State<_A>

where &'a mut _A: BitOr<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the | operator.

fn bitor( self, rhs: &'a mut State<_B>, ) -> <&'a mut State<_A> as BitOr<&'a mut State<_B>>>::Output

Performs the | operation.

impl<'a, _A, _B, _C> BitOr<&'a mut State<_B>> for State<_A>

where _A: BitOr<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the | operator.

fn bitor( self, rhs: &'a mut State<_B>, ) -> <State<_A> as BitOr<&'a mut State<_B>>>::Output

Performs the | operation.

impl<'a, _A, _B, _C> BitOr<State<_B>> for &'a State<_A>

where &'a _A: BitOr<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the | operator.

fn bitor(self, rhs: State<_B>) -> <&'a State<_A> as BitOr<State<_B>>>::Output

Performs the | operation.

impl<'a, _A, _B, _C> BitOr<State<_B>> for &'a mut State<_A>

where &'a mut _A: BitOr<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the | operator.

fn bitor( self, rhs: State<_B>, ) -> <&'a mut State<_A> as BitOr<State<_B>>>::Output

Performs the | operation.

impl<_A, _B, _C> BitOr<State<_B>> for State<_A>

where _A: BitOr<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the | operator.

fn bitor(self, rhs: State<_B>) -> <State<_A> as BitOr<State<_B>>>::Output

Performs the | operation.

impl<_A, _B> BitOrAssign<State<_B>> for State<_A>

where _A: BitOrAssign<_B>,

fn bitor_assign(&mut self, rhs: State<_B>)

Performs the |= operation.

impl<'a, _A, _B, _C> BitXor<&'a State<_B>> for &'a State<_A>

where &'a _A: BitXor<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the ^ operator.

fn bitxor( self, rhs: &'a State<_B>, ) -> <&'a State<_A> as BitXor<&'a State<_B>>>::Output

Performs the ^ operation.

impl<'a, _A, _B, _C> BitXor<&'a State<_B>> for State<_A>

where _A: BitXor<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the ^ operator.

fn bitxor( self, rhs: &'a State<_B>, ) -> <State<_A> as BitXor<&'a State<_B>>>::Output

Performs the ^ operation.

impl<'a, _A, _B, _C> BitXor<&'a mut State<_B>> for &'a mut State<_A>

where &'a mut _A: BitXor<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the ^ operator.

fn bitxor( self, rhs: &'a mut State<_B>, ) -> <&'a mut State<_A> as BitXor<&'a mut State<_B>>>::Output

Performs the ^ operation.

impl<'a, _A, _B, _C> BitXor<&'a mut State<_B>> for State<_A>

where _A: BitXor<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the ^ operator.

fn bitxor( self, rhs: &'a mut State<_B>, ) -> <State<_A> as BitXor<&'a mut State<_B>>>::Output

Performs the ^ operation.

impl<'a, _A, _B, _C> BitXor<State<_B>> for &'a State<_A>

where &'a _A: BitXor<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: State<_B>) -> <&'a State<_A> as BitXor<State<_B>>>::Output

Performs the ^ operation.

impl<'a, _A, _B, _C> BitXor<State<_B>> for &'a mut State<_A>

where &'a mut _A: BitXor<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the ^ operator.

fn bitxor( self, rhs: State<_B>, ) -> <&'a mut State<_A> as BitXor<State<_B>>>::Output

Performs the ^ operation.

impl<_A, _B, _C> BitXor<State<_B>> for State<_A>

where _A: BitXor<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: State<_B>) -> <State<_A> as BitXor<State<_B>>>::Output

Performs the ^ operation.

impl<_A, _B> BitXorAssign<State<_B>> for State<_A>

where _A: BitXorAssign<_B>,

fn bitxor_assign(&mut self, rhs: State<_B>)

Performs the ^= operation.

impl<Q> Borrow<Q> for State<Q>

where Q: RawState,

fn borrow(&self) -> &Q

Immutably borrows from an owned value.

impl<Q> BorrowMut<Q> for State<Q>

where Q: RawState,

fn borrow_mut(&mut self) -> &mut Q

Mutably borrows from an owned value.

impl<Q> Clone for State<Q>

where Q: Clone + ?Sized,

fn clone(&self) -> State<Q>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q> Debug for State<Q>

where Q: Debug,

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

Formats the value using the given formatter.

impl<Q> Default for State<Q>

where Q: Default + ?Sized,

fn default() -> State<Q>

Returns the “default value” for a type.

impl<Q> Deref for State<Q>

where Q: RawState,

type Target = Q

The resulting type after dereferencing.

fn deref(&self) -> &<State<Q> as Deref>::Target

Dereferences the value.

impl<Q> DerefMut for State<Q>

where Q: RawState,

fn deref_mut(&mut self) -> &mut <State<Q> as Deref>::Target

Mutably dereferences the value.

impl<'de, Q> Deserialize<'de> for State<Q>

where State<Q>: Default, Q: Deserialize<'de> + ?Sized,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Q> Display for State<Q>

where Q: Display,

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

Formats the value using the given formatter.

impl<'a, _A, _B, _C> Div<&'a State<_B>> for &'a State<_A>

where &'a _A: Div<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the / operator.

fn div( self, rhs: &'a State<_B>, ) -> <&'a State<_A> as Div<&'a State<_B>>>::Output

Performs the / operation.

impl<'a, _A, _B, _C> Div<&'a State<_B>> for State<_A>

where _A: Div<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the / operator.

fn div(self, rhs: &'a State<_B>) -> <State<_A> as Div<&'a State<_B>>>::Output

Performs the / operation.

impl<'a, _A, _B, _C> Div<&'a mut State<_B>> for &'a mut State<_A>

where &'a mut _A: Div<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the / operator.

fn div( self, rhs: &'a mut State<_B>, ) -> <&'a mut State<_A> as Div<&'a mut State<_B>>>::Output

Performs the / operation.

impl<'a, _A, _B, _C> Div<&'a mut State<_B>> for State<_A>

where _A: Div<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the / operator.

fn div( self, rhs: &'a mut State<_B>, ) -> <State<_A> as Div<&'a mut State<_B>>>::Output

Performs the / operation.

impl<'a, _A, _B, _C> Div<State<_B>> for &'a State<_A>

where &'a _A: Div<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the / operator.

fn div(self, rhs: State<_B>) -> <&'a State<_A> as Div<State<_B>>>::Output

Performs the / operation.

impl<'a, _A, _B, _C> Div<State<_B>> for &'a mut State<_A>

where &'a mut _A: Div<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the / operator.

fn div(self, rhs: State<_B>) -> <&'a mut State<_A> as Div<State<_B>>>::Output

Performs the / operation.

impl<_A, _B, _C> Div<State<_B>> for State<_A>

where _A: Div<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the / operator.

fn div(self, rhs: State<_B>) -> <State<_A> as Div<State<_B>>>::Output

Performs the / operation.

impl<_A, _B> DivAssign<State<_B>> for State<_A>

where _A: DivAssign<_B>,

fn div_assign(&mut self, rhs: State<_B>)

Performs the /= operation.

impl<Q> From<Q> for State<Q>

where Q: RawState,

fn from(from: Q) -> State<Q>

Converts to this type from the input type.

impl<Q> Hash for State<Q>

where Q: Hash + ?Sized,

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<Q> LowerExp for State<Q>

where Q: LowerExp,

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

Formats the value using the given formatter.

impl<Q> LowerHex for State<Q>

where Q: LowerHex,

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

Formats the value using the given formatter.

impl<'a, _A, _B, _C> Mul<&'a State<_B>> for &'a State<_A>

where &'a _A: Mul<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the * operator.

fn mul( self, rhs: &'a State<_B>, ) -> <&'a State<_A> as Mul<&'a State<_B>>>::Output

Performs the * operation.

impl<'a, _A, _B, _C> Mul<&'a State<_B>> for State<_A>

where _A: Mul<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a State<_B>) -> <State<_A> as Mul<&'a State<_B>>>::Output

Performs the * operation.

impl<'a, _A, _B, _C> Mul<&'a mut State<_B>> for &'a mut State<_A>

where &'a mut _A: Mul<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the * operator.

fn mul( self, rhs: &'a mut State<_B>, ) -> <&'a mut State<_A> as Mul<&'a mut State<_B>>>::Output

Performs the * operation.

impl<'a, _A, _B, _C> Mul<&'a mut State<_B>> for State<_A>

where _A: Mul<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the * operator.

fn mul( self, rhs: &'a mut State<_B>, ) -> <State<_A> as Mul<&'a mut State<_B>>>::Output

Performs the * operation.

impl<'a, _A, _B, _C> Mul<State<_B>> for &'a State<_A>

where &'a _A: Mul<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: State<_B>) -> <&'a State<_A> as Mul<State<_B>>>::Output

Performs the * operation.

impl<'a, _A, _B, _C> Mul<State<_B>> for &'a mut State<_A>

where &'a mut _A: Mul<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: State<_B>) -> <&'a mut State<_A> as Mul<State<_B>>>::Output

Performs the * operation.

impl<_A, _B, _C> Mul<State<_B>> for State<_A>

where _A: Mul<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: State<_B>) -> <State<_A> as Mul<State<_B>>>::Output

Performs the * operation.

impl<_A, _B> MulAssign<State<_B>> for State<_A>

where _A: MulAssign<_B>,

fn mul_assign(&mut self, rhs: State<_B>)

Performs the *= operation.

impl<'a, _A, _B> Neg for &'a State<_A>

where &'a _A: Neg<Output = _B>,

type Output = State<_B>

The resulting type after applying the - operator.

fn neg(self) -> <&'a State<_A> as Neg>::Output

Performs the unary - operation.

impl<'a, _A, _B> Neg for &'a mut State<_A>

where &'a mut _A: Neg<Output = _B>,

type Output = State<_B>

The resulting type after applying the - operator.

fn neg(self) -> <&'a mut State<_A> as Neg>::Output

Performs the unary - operation.

impl<_A, _B> Neg for State<_A>

where _A: Neg<Output = _B>,

type Output = State<_B>

The resulting type after applying the - operator.

fn neg(self) -> <State<_A> as Neg>::Output

Performs the unary - operation.

impl<'a, _A, _B> Not for &'a State<_A>

where &'a _A: Not<Output = _B>,

type Output = State<_B>

The resulting type after applying the ! operator.

fn not(self) -> <&'a State<_A> as Not>::Output

Performs the unary ! operation.

impl<'a, _A, _B> Not for &'a mut State<_A>

where &'a mut _A: Not<Output = _B>,

type Output = State<_B>

The resulting type after applying the ! operator.

fn not(self) -> <&'a mut State<_A> as Not>::Output

Performs the unary ! operation.

impl<_A, _B> Not for State<_A>

where _A: Not<Output = _B>,

type Output = State<_B>

The resulting type after applying the ! operator.

fn not(self) -> <State<_A> as Not>::Output

Performs the unary ! operation.

impl<Q> Num for State<Q>

where Q: RawState + Num,

type FromStrRadixErr = <Q as Num>::FromStrRadixErr

fn from_str_radix( s: &str, radix: u32, ) -> Result<State<Q>, <State<Q> as Num>::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl<Q> Octal for State<Q>

where Q: Octal,

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

Formats the value using the given formatter.

impl<Q> One for State<Q>

where Q: RawState + One,

fn one() -> State<Q>

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl<Q> Ord for State<Q>

where Q: Ord + ?Sized,

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

where Q: RawState + PartialEq,

fn eq(&self, other: &&'a Q) -> 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<'a, Q> PartialEq<&'a mut Q> for State<Q>

where Q: RawState + PartialEq,

fn eq(&self, other: &&'a mut Q) -> 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> PartialEq<Q> for State<Q>

where Q: RawState + PartialEq,

fn eq(&self, other: &Q) -> 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> PartialEq for State<Q>

where Q: PartialEq + ?Sized,

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

where Q: RawState + PartialOrd,

fn partial_cmp(&self, other: &Q) -> 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> PartialOrd for State<Q>

where Q: PartialOrd + ?Sized,

fn partial_cmp(&self, other: &State<Q>) -> 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> Pointer for State<Q>

where Q: Pointer,

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

Formats the value using the given formatter.

impl<'a, _A, _B, _C> Rem<&'a State<_B>> for &'a State<_A>

where &'a _A: Rem<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the % operator.

fn rem( self, rhs: &'a State<_B>, ) -> <&'a State<_A> as Rem<&'a State<_B>>>::Output

Performs the % operation.

impl<'a, _A, _B, _C> Rem<&'a State<_B>> for State<_A>

where _A: Rem<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a State<_B>) -> <State<_A> as Rem<&'a State<_B>>>::Output

Performs the % operation.

impl<'a, _A, _B, _C> Rem<&'a mut State<_B>> for &'a mut State<_A>

where &'a mut _A: Rem<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the % operator.

fn rem( self, rhs: &'a mut State<_B>, ) -> <&'a mut State<_A> as Rem<&'a mut State<_B>>>::Output

Performs the % operation.

impl<'a, _A, _B, _C> Rem<&'a mut State<_B>> for State<_A>

where _A: Rem<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the % operator.

fn rem( self, rhs: &'a mut State<_B>, ) -> <State<_A> as Rem<&'a mut State<_B>>>::Output

Performs the % operation.

impl<'a, _A, _B, _C> Rem<State<_B>> for &'a State<_A>

where &'a _A: Rem<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: State<_B>) -> <&'a State<_A> as Rem<State<_B>>>::Output

Performs the % operation.

impl<'a, _A, _B, _C> Rem<State<_B>> for &'a mut State<_A>

where &'a mut _A: Rem<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: State<_B>) -> <&'a mut State<_A> as Rem<State<_B>>>::Output

Performs the % operation.

impl<_A, _B, _C> Rem<State<_B>> for State<_A>

where _A: Rem<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: State<_B>) -> <State<_A> as Rem<State<_B>>>::Output

Performs the % operation.

impl<_A, _B> RemAssign<State<_B>> for State<_A>

where _A: RemAssign<_B>,

fn rem_assign(&mut self, rhs: State<_B>)

Performs the %= operation.

impl<Q> Serialize for State<Q>

where Q: Serialize + ?Sized,

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<'a, _A, _B, _C> Shl<&'a State<_B>> for &'a State<_A>

where &'a _A: Shl<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the << operator.

fn shl( self, rhs: &'a State<_B>, ) -> <&'a State<_A> as Shl<&'a State<_B>>>::Output

Performs the << operation.

impl<'a, _A, _B, _C> Shl<&'a State<_B>> for State<_A>

where _A: Shl<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: &'a State<_B>) -> <State<_A> as Shl<&'a State<_B>>>::Output

Performs the << operation.

impl<'a, _A, _B, _C> Shl<&'a mut State<_B>> for &'a mut State<_A>

where &'a mut _A: Shl<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the << operator.

fn shl( self, rhs: &'a mut State<_B>, ) -> <&'a mut State<_A> as Shl<&'a mut State<_B>>>::Output

Performs the << operation.

impl<'a, _A, _B, _C> Shl<&'a mut State<_B>> for State<_A>

where _A: Shl<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the << operator.

fn shl( self, rhs: &'a mut State<_B>, ) -> <State<_A> as Shl<&'a mut State<_B>>>::Output

Performs the << operation.

impl<'a, _A, _B, _C> Shl<State<_B>> for &'a State<_A>

where &'a _A: Shl<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: State<_B>) -> <&'a State<_A> as Shl<State<_B>>>::Output

Performs the << operation.

impl<'a, _A, _B, _C> Shl<State<_B>> for &'a mut State<_A>

where &'a mut _A: Shl<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: State<_B>) -> <&'a mut State<_A> as Shl<State<_B>>>::Output

Performs the << operation.

impl<_A, _B, _C> Shl<State<_B>> for State<_A>

where _A: Shl<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: State<_B>) -> <State<_A> as Shl<State<_B>>>::Output

Performs the << operation.

impl<_A, _B> ShlAssign<State<_B>> for State<_A>

where _A: ShlAssign<_B>,

fn shl_assign(&mut self, rhs: State<_B>)

Performs the <<= operation.

impl<'a, _A, _B, _C> Shr<&'a State<_B>> for &'a State<_A>

where &'a _A: Shr<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the >> operator.

fn shr( self, rhs: &'a State<_B>, ) -> <&'a State<_A> as Shr<&'a State<_B>>>::Output

Performs the >> operation.

impl<'a, _A, _B, _C> Shr<&'a State<_B>> for State<_A>

where _A: Shr<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: &'a State<_B>) -> <State<_A> as Shr<&'a State<_B>>>::Output

Performs the >> operation.

impl<'a, _A, _B, _C> Shr<&'a mut State<_B>> for &'a mut State<_A>

where &'a mut _A: Shr<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the >> operator.

fn shr( self, rhs: &'a mut State<_B>, ) -> <&'a mut State<_A> as Shr<&'a mut State<_B>>>::Output

Performs the >> operation.

impl<'a, _A, _B, _C> Shr<&'a mut State<_B>> for State<_A>

where _A: Shr<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the >> operator.

fn shr( self, rhs: &'a mut State<_B>, ) -> <State<_A> as Shr<&'a mut State<_B>>>::Output

Performs the >> operation.

impl<'a, _A, _B, _C> Shr<State<_B>> for &'a State<_A>

where &'a _A: Shr<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: State<_B>) -> <&'a State<_A> as Shr<State<_B>>>::Output

Performs the >> operation.

impl<'a, _A, _B, _C> Shr<State<_B>> for &'a mut State<_A>

where &'a mut _A: Shr<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: State<_B>) -> <&'a mut State<_A> as Shr<State<_B>>>::Output

Performs the >> operation.

impl<_A, _B, _C> Shr<State<_B>> for State<_A>

where _A: Shr<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: State<_B>) -> <State<_A> as Shr<State<_B>>>::Output

Performs the >> operation.

impl<_A, _B> ShrAssign<State<_B>> for State<_A>

where _A: ShrAssign<_B>,

fn shr_assign(&mut self, rhs: State<_B>)

Performs the >>= operation.

impl<Q> StateRepr for State<Q>

where Q: RawState,

type Item = Q

impl<'a, _A, _B, _C> Sub<&'a State<_B>> for &'a State<_A>

where &'a _A: Sub<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the - operator.

fn sub( self, rhs: &'a State<_B>, ) -> <&'a State<_A> as Sub<&'a State<_B>>>::Output

Performs the - operation.

impl<'a, _A, _B, _C> Sub<&'a State<_B>> for State<_A>

where _A: Sub<&'a _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a State<_B>) -> <State<_A> as Sub<&'a State<_B>>>::Output

Performs the - operation.

impl<'a, _A, _B, _C> Sub<&'a mut State<_B>> for &'a mut State<_A>

where &'a mut _A: Sub<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the - operator.

fn sub( self, rhs: &'a mut State<_B>, ) -> <&'a mut State<_A> as Sub<&'a mut State<_B>>>::Output

Performs the - operation.

impl<'a, _A, _B, _C> Sub<&'a mut State<_B>> for State<_A>

where _A: Sub<&'a mut _B, Output = _C>,

type Output = State<_C>

The resulting type after applying the - operator.

fn sub( self, rhs: &'a mut State<_B>, ) -> <State<_A> as Sub<&'a mut State<_B>>>::Output

Performs the - operation.

impl<'a, _A, _B, _C> Sub<State<_B>> for &'a State<_A>

where &'a _A: Sub<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: State<_B>) -> <&'a State<_A> as Sub<State<_B>>>::Output

Performs the - operation.

impl<'a, _A, _B, _C> Sub<State<_B>> for &'a mut State<_A>

where &'a mut _A: Sub<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: State<_B>) -> <&'a mut State<_A> as Sub<State<_B>>>::Output

Performs the - operation.

impl<_A, _B, _C> Sub<State<_B>> for State<_A>

where _A: Sub<_B, Output = _C>,

type Output = State<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: State<_B>) -> <State<_A> as Sub<State<_B>>>::Output

Performs the - operation.

impl<_A, _B> SubAssign<State<_B>> for State<_A>

where _A: SubAssign<_B>,

fn sub_assign(&mut self, rhs: State<_B>)

Performs the -= operation.

impl<Q> UpperExp for State<Q>

where Q: UpperExp,

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

Formats the value using the given formatter.

impl<Q> UpperHex for State<Q>

where Q: UpperHex,

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

Formats the value using the given formatter.

impl<Q> Zero for State<Q>

where Q: RawState + Zero,

fn zero() -> State<Q>

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<Q> Copy for State<Q>

where Q: Copy + ?Sized,

impl<Q> Eq for State<Q>

where Q: Eq + ?Sized,

impl<Q> StructuralPartialEq for State<Q>

where Q: ?Sized,