Trait State

pub trait State {
    type Event;
    type Error;

    // Required methods
    fn enqueue_input(&mut self, bytes: &[u8]);
    fn next(&mut self) -> Result<Self::Event, Interrupt<Self::Error>>;
}

State machine with sans I/O pattern.

This trait is the interface between types that implement IMAP protocol flows and I/O drivers. Most notably Client and Server both implement this trait whereas Stream uses the trait for implementing the I/O drivers.

Required Associated Types

type Event

Event emitted while progressing the state.

type Error

Error emitted while progressing the state.

Required Methods

fn enqueue_input(&mut self, bytes: &[u8])

Enqueue input bytes.

These bytes may be used during the next Self::next call.

fn next(&mut self) -> Result<Self::Event, Interrupt<Self::Error>>

Progress the state until the next event (or interrupt).

Implementations on Foreign Types

impl<F: State> State for &mut F

type Event = <F as State>::Event

type Error = <F as State>::Error

fn enqueue_input(&mut self, bytes: &[u8])

fn next(&mut self) -> Result<Self::Event, Interrupt<Self::Error>>

Implementors

impl State for Client

type Event = Event

type Error = Error

impl State for Server

type Event = Event

type Error = Error