Struct State

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

State is a generalized state implementation, representing the state of a system or object.

Tuple Fields

0: Q

Implementations

impl<'a, Q> State<&'a Q>

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

where Q: Clone,

Clones the internal state and returning a new instance of State

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

where Q: Copy,

Copies the internal state and returning a new instance of State

impl<'a, Q> State<&'a mut Q>

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

where Q: Clone,

Clones the internal state and returning a new instance of State

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

where Q: Copy,

Copies the internal state and returning a new instance of State

impl<Q> State<*const Q>

pub fn from_ptr(ptr: *const Q) -> Self

Creates a new instance of state with a raw pointer to the inner value.

impl<Q> State<*mut Q>

pub fn from_mut_ptr(ptr: *mut Q) -> Self

Creates a new instance of state with a mutable raw pointer to the inner value.

impl<Q> State<MaybeUninit<Q>>

pub fn init(value: Q) -> Self

Creates a new instance of state with an initialized inner value.

pub const fn uninit() -> Self

Creates a new instance of state with an uninitialized inner value.

pub unsafe fn assume_init(self) -> State<Q>

Converts the state into a new instance of State with an initialized state.

pub fn is_null(&self) -> bool

determines if the inner state is null; returns false if the inner state is not null.

pub fn write(&mut self, value: Q) -> &mut Q

Writes a value to the inner state.

impl State<()>

pub fn empty() -> Self

Creates a new instance of State with an empty state.

impl State<bool>

pub fn from_true() -> Self

pub fn from_false() -> Self

pub fn is_true(&self) -> bool

pub fn is_false(&self) -> bool

impl State<Box<dyn Any>>

pub fn downcast<Q>(self) -> Result<State<Box<Q>>, Error>

where Q: Any,

Attempts to downcast the state to a concrete type Q; returns an error if the state is not of type Q.

pub fn downcast_ref<Q>(&self) -> Option<State<&Q>>

where Q: Any,

Returns an immutable reference to the state if it is of type Q; returns None otherwise.

pub fn downcast_mut<Q>(&mut self) -> Option<State<&mut Q>>

where Q: Any,

Returns a mutable reference to the state if it is of type Q; returns None otherwise.

impl<Q> State<Option<Q>>

pub fn none() -> Self

Creates a new instance of state whose inner state is Option::None.

pub fn some(value: Q) -> Self

Creates a new instance of state whose inner state is Option::Some.

impl<Q> State<Halt<Q>>

pub fn halted(Halt: Halt<Q>) -> Self

Creates a new instance of State from a Halt state.

pub fn unhalt(self) -> State<Q>

Converts the halted state into an unhalted state.

impl<Q> State<Q>

pub fn from_value(state: Q) -> Self

pub fn as_ptr(&self) -> *const Q

Returns a new instance of state with a raw pointer to the inner value.

pub fn as_mut_ptr(&mut self) -> *mut Q

Returns a new instance of state with a mutable raw pointer to the inner value.

pub unsafe fn cast<R>(self) -> State<R>

Casts the state to a new type, returning a new instance of State.

Saftey

This method is unsafe because it is up to the caller to ensure that the cast is valid.

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

Returns an immutable reference to the inner value of the state.

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

Returns a mutable reference to the inner value of the state.

pub fn into_inner(self) -> Q

Consumes and returns the inner value of the state.

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

where F: FnOnce(Q) -> R,

State::map applies the given function onto the inner value of the state, returning a new state with the result.

pub fn map_mut<R, F>(&mut self, f: F) -> State<R>

where F: FnMut(&mut Q) -> R,

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

Replaces the state with a new value, returning the old value.

pub fn reset(&mut self)

where Q: Default,

Clears the state, setting it to its default value.

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

Sets the state to a new value.

pub fn swap<S>(&mut self, other: &mut S)

where S: RawState<Q = Q>,

Swaps the inner value of the state with that of the given state.

pub fn take(&mut self) -> Q

where Q: Default,

Takes the inner value of the state, replacing it with the default value and returning the previous value.

pub fn as_halt(&self) -> State<Halt<&Q>>

Returns a halted state with an immutable reference to the state.

pub fn into_halt(self) -> State<Halt<Q>>

Consumes the state and returns a halted state.

pub fn halt(self) -> State<Halt<Q>>

Wraps the inner value with a Halt state, returning a new instance of State.

pub fn is_halt(&self) -> bool

where Q: 'static,

Returns true if the state is a Halt state.

pub fn boxed(self) -> State<Box<Q>>

Returns a new state with a boxed inner value.

pub fn as_any(&self) -> State<Box<dyn Any>>

where Q: Clone + 'static,

Converts the inner type into a boxed “any” state, returning a new instance of state

pub fn into_any(self) -> State<Box<dyn Any>>

where Q: 'static,

Converts the inner type into a boxed “any” state, returning a new instance of state

pub fn shared(self) -> State<Arc<Q>>

Wraps the inner value of the state with an [Arc] and returns a new instance of State

pub fn to_shared(&self) -> State<Arc<Q>>

where Q: Clone,

Returns a shared reference to the state.

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

Returns a state with an owned inner value.

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

Returns a state with a mutable reference to the inner value.

pub fn get_inner_type_name(&self) -> &'static str

Returns the name of the generic inner type, Q.

pub fn get_inner_type_id(&self) -> TypeId

where Q: 'static,

Returns the type id of the generic inner type, Q.

Trait Implementations

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>) -> Self::Output

Performs the + operation.

impl<A, B> AddAssign<B> for State<A>

where A: AddAssign<B>,

fn add_assign(&mut self, rhs: B)

Performs the += operation.

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

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>

fn as_ref(&self) -> &Q

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

impl<T: Binary> Binary for State<T>

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

Formats the value using the given formatter.

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>) -> Self::Output

Performs the & operation.

impl<A, B> BitAndAssign<B> for State<A>

where A: BitAndAssign<B>,

fn bitand_assign(&mut self, rhs: B)

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>) -> Self::Output

Performs the | operation.

impl<A, B> BitOrAssign<B> for State<A>

where A: BitOrAssign<B>,

fn bitor_assign(&mut self, rhs: B)

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>) -> Self::Output

Performs the ^ operation.

impl<A, B> BitXorAssign<B> for State<A>

where A: BitXorAssign<B>,

fn bitxor_assign(&mut self, rhs: B)

Performs the ^= operation.

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

fn borrow(&self) -> &Q

Immutably borrows from an owned value.

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

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

Mutably borrows from an owned value.

impl<Q: Clone + ?Sized> Clone for State<Q>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Q: Debug + ?Sized> Debug for State<Q>

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

Formats the value using the given formatter.

impl<Q: Default + ?Sized> Default for State<Q>

fn default() -> State<Q>

Returns the “default value” for a type.

impl<Q> Deref for State<Q>

type Target = Q

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Q> DerefMut for State<Q>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for State<T>

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

Formats the value using the given formatter.

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>) -> Self::Output

Performs the / operation.

impl<A, B> DivAssign<B> for State<A>

where A: DivAssign<B>,

fn div_assign(&mut self, rhs: B)

Performs the /= operation.

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

fn from(Halt: Halt<Q>) -> Self

Converts to this type from the input type.

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

fn from(state: Q) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<Q> Haltable<Q> for State<Halt<Q>>

type State = State<Q>

fn is_halted(&self) -> bool

impl<Q> Haltable<Q> for State<Option<Q>>

type State = State<Q>

fn is_halted(&self) -> bool

impl<Q: Hash + ?Sized> Hash for State<Q>

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<T: LowerExp> LowerExp for State<T>

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

Formats the value using the given formatter.

impl<T: LowerHex> LowerHex for State<T>

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

Formats the value using the given formatter.

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>) -> Self::Output

Performs the * operation.

impl<A, B> MulAssign<B> for State<A>

where A: MulAssign<B>,

fn mul_assign(&mut self, rhs: B)

Performs the *= operation.

impl<'a, Q> Neg for &'a State<Q>

where &'a Q: Neg,

type Output = State<<&'a Q as Neg>::Output>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<Q> Neg for State<Q>

where Q: Neg,

type Output = State<<Q as Neg>::Output>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'a, Q> Not for &'a State<Q>

where &'a Q: Not,

type Output = State<<&'a Q as Not>::Output>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<Q> Not for State<Q>

where Q: Not,

type Output = State<<Q as Not>::Output>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<Q> Num for State<Q>

where Q: Num,

type FromStrRadixErr = <Q as Num>::FromStrRadixErr

fn from_str_radix(str: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>

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

impl<T: Octal> Octal for State<T>

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

Formats the value using the given formatter.

impl<Q> One for State<Q>

where Q: PartialEq + One,

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

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

impl<Q: Ord + ?Sized> Ord for State<Q>

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, S> PartialEq<Head<Q, S>> for State<&'a Q>

where Q: PartialEq,

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

where Q: PartialEq,

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

where Q: PartialEq,

fn eq(&self, state: &State<&'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<Q, S> PartialEq<State<Q>> for Head<Q, S>

where Q: PartialEq,

fn eq(&self, state: &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: PartialEq + ?Sized> PartialEq for State<Q>

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: PartialOrd<Q>,

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 + ?Sized> PartialOrd for State<Q>

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<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>) -> Self::Output

Performs the % operation.

impl<A, B> RemAssign<B> for State<A>

where A: RemAssign<B>,

fn rem_assign(&mut self, rhs: B)

Performs the %= operation.

impl<Q> Serialize for State<Q>

where Q: Serialize + ?Sized,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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>) -> Self::Output

Performs the << operation.

impl<A, B> ShlAssign<B> for State<A>

where A: ShlAssign<B>,

fn shl_assign(&mut self, rhs: B)

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>) -> Self::Output

Performs the >> operation.

impl<A, B> ShrAssign<B> for State<A>

where A: ShrAssign<B>,

fn shr_assign(&mut self, rhs: B)

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>) -> Self::Output

Performs the - operation.

impl<A, B> SubAssign<B> for State<A>

where A: SubAssign<B>,

fn sub_assign(&mut self, rhs: B)

Performs the -= operation.

impl<T: UpperExp> UpperExp for State<T>

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

Formats the value using the given formatter.

impl<T: UpperHex> UpperHex for State<T>

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

Formats the value using the given formatter.

impl<Q> Zero for State<Q>

where Q: Zero,

fn zero() -> Self

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 + ?Sized> Copy for State<Q>

impl<Q: Eq + ?Sized> Eq for State<Q>

impl<Q> Send for State<Q>

where Q: Send,

impl<Q: ?Sized> StructuralPartialEq for State<Q>

impl<Q> Sync for State<Q>

where Q: Sync,