Struct Halt

pub struct Halt<Q>(pub Q);

Tuple Fields

0: Q

Implementations

impl<Q> Halt<Q>

pub fn new(halt: Q) -> Self

pub fn get(self) -> Q

Consumes the halted state and returns the inner value.

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

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

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

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

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

Replaces the inner value of the halted state with the given value, returning the previous value.

pub fn reset(&mut self)

where Q: Default,

Resets the inner value of the halted state to the default value of the type.

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

Sets the inner value of the halted state to that of the given value.

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

where S: Stated<Item = Q>,

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

pub fn take(&mut self) -> Q

where Q: Default,

Takes the inner value of the halted state and replaces it with the default value of the type.

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

Converts the halted state into a new State with an immutable reference to the inner value.

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

Converts the halted state into a new State with a mutable reference to the inner value.

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

Wraps the halted state and returns a new State

pub fn view(&self) -> Halt<&Q>

Returns an instance of Halt with an immutable reference to the inner value.

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

Returns an instance of Halt with a mutable reference to the inner value.

impl<Q> Halt<&Q>

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

where Q: Clone,

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

where Q: Copy,

impl<Q> Halt<&mut Q>

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

where Q: Clone,

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

where Q: Copy,

Trait Implementations

impl<Q: Clone> Clone for Halt<Q>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q: Debug> Debug for Halt<Q>

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

Formats the value using the given formatter.

impl<Q: Default> Default for Halt<Q>

fn default() -> Halt<Q>

Returns the “default value” for a type.

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

where 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> From<Halt<Q>> for HaltState<Q>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

type State = State<Q>

fn is_halted(&self) -> bool

impl<Q: Hash> Hash for Halt<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<Q: Ord> Ord for Halt<Q>

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

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

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

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> Stated for Halt<Q>

type Item = Q

fn get(self) -> Q

fn get_ref(&self) -> &Q

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

fn set(&mut self, inner: Q)

impl<Q: Copy> Copy for Halt<Q>

impl<Q: Eq> Eq for Halt<Q>

impl<Q> StructuralPartialEq for Halt<Q>