Trait Stateful 

pub trait Stateful<CONTEXT, STATE> {
    // Required methods
    fn from_parts(context: CONTEXT, state: STATE) -> Self
       where Self: Sized + 'static;
    fn into_parts(self) -> (CONTEXT, STATE);
    fn context(&self) -> &CONTEXT;
    fn state(&self) -> &STATE;
    fn state_mut(&mut self) -> &mut STATE;

    // Provided method
    fn configure<I1: Into<CONTEXT>, I2: Into<STATE>>(
        context: I1,
        initial_state: I2,
    ) -> Self
       where Self: Sized + 'static { ... }
}

A shared interface of objects that provide access to an immutable CONTEXT and mutable STATE.

Required Methods

fn from_parts(context: CONTEXT, state: STATE) -> Self

where Self: Sized + 'static,

Create new Stateful instance from CONTEXT and STATE.

fn into_parts(self) -> (CONTEXT, STATE)

Destruct the Stateful instance into CONTEXT and STATE objects.

fn context(&self) -> &CONTEXT

Access to the underlying immutable CONTEXT.

fn state(&self) -> &STATE

Access to the underlying STATE.

fn state_mut(&mut self) -> &mut STATE

Access to the underlying STATE as a mutable reference.

Keep in mind that having a consistent state is important for the correctness of Algorithm and GenAlgorithm. You should modify the internal state of a Stateful object only in rare, well-defined situations.

Provided Methods

fn configure<I1: Into<CONTEXT>, I2: Into<STATE>>( context: I1, initial_state: I2, ) -> Self

where Self: Sized + 'static,

Create new Stateful instance using values that can be converted to CONTEXT and STATE.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<CONTEXT, STATE, ITEM, STEP: GeneratorStep<CONTEXT, STATE, ITEM>> Stateful<CONTEXT, STATE> for Generator<CONTEXT, STATE, ITEM, STEP>

impl<CONTEXT, STATE, OUTPUT, STEP: ComputationStep<CONTEXT, STATE, OUTPUT>> Stateful<CONTEXT, STATE> for Computation<CONTEXT, STATE, OUTPUT, STEP>