Struct Response

pub struct Response<M, N>(/* private fields */);

The response of a state machine to the (mio) action

This value is returned by many methods of the Machine trait.

Implementations

impl<M: Sized, N: Sized> Response<M, N>

pub fn ok(machine: M) -> Response<M, N>

pub fn spawn(machine: M, result: N) -> Response<M, N>

pub fn done() -> Response<M, N>

pub fn error(e: Box<dyn Error>) -> Response<M, N>

pub fn deadline(self, time: Time) -> Response<M, N>

pub fn map<T, U, S, R>(self, self_mapper: S, result_mapper: R) -> Response<T, U>

where S: FnOnce(M) -> T, R: FnOnce(N) -> U,

Maps state machine and/or spawned result with a function

Usually it’s okay to use constructor of wrapper state machine here as a mapper

pub fn wrap<T, S>(self, self_mapper: S) -> Response<T, N>

where S: FnOnce(M) -> T,

Similar to map but only maps state machine

This is especially useful in state machine constructors, which have a Void child type.

pub fn is_stopped(&self) -> bool

Returns true if state machine is stopped

I.e. the method returns true if the Response was created either with Response::done or Response::error

pub fn cause(&self) -> Option<&dyn Error>

Return a reference to an error passed to Response::error

Returns None if any other constructor was used.

This is mostly useful for printing the error.

impl<M: Sized + Debug, N: Sized + Debug> Response<M, N>

pub fn expect_machine(self) -> M

Return state machine if response created with Response::ok(..)

Use only for unit tests

If the response is not okay, the function panics.

pub fn expect_spawn(self) -> (M, N)

Return a tuple if response created with Response::spawn(..)

Use only for unit tests

If the response is not spawn, the function panics.

pub fn expect_done(self)

Returns if response created with Response::done()

Use only for unit tests

If the response is not done, the function panics.

pub fn expect_error(self) -> Box<dyn Error>

Returns an error if response created with Response::error(..)

Use only for unit tests

If the response does not contain error, the function panics.