Skip to main content

State

Struct State 

Source
pub struct State<S, A> { /* private fields */ }
Expand description

A State monad: transforms state S into (A, S).

Implementations§

Source§

impl<S: 'static, A: 'static> State<S, A>

Source

pub fn new(f: impl FnOnce(S) -> (A, S) + 'static) -> Self

Create a State from a state transformation function.

Source

pub fn pure(a: A) -> Self
where A: Clone,

Lift a pure value into the State monad.

Source

pub fn bind<B: 'static>( self, f: impl FnOnce(A) -> State<S, B> + 'static, ) -> State<S, B>

Monadic bind.

Source

pub fn map<B: 'static>(self, f: impl FnOnce(A) -> B + 'static) -> State<S, B>

Map over the result value.

Source

pub fn run(self, initial: S) -> (A, S)

Run the state computation with an initial state.

Source

pub fn eval(self, initial: S) -> A

Run and return only the value.

Source

pub fn exec(self, initial: S) -> S

Run and return only the final state.

Source

pub fn get() -> State<S, S>
where S: Clone,

Read the current state.

Source

pub fn put(new_s: S) -> State<S, ()>
where S: 'static,

Set a new state.

Source

pub fn modify(f: impl FnOnce(S) -> S + 'static) -> State<S, ()>

Modify the state with a function.

Auto Trait Implementations§

§

impl<S, A> Freeze for State<S, A>

§

impl<S, A> !RefUnwindSafe for State<S, A>

§

impl<S, A> !Send for State<S, A>

§

impl<S, A> !Sync for State<S, A>

§

impl<S, A> Unpin for State<S, A>

§

impl<S, A> UnsafeUnpin for State<S, A>

§

impl<S, A> !UnwindSafe for State<S, A>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.