Skip to main content

TurnMachine

Struct TurnMachine 

Source
pub struct TurnMachine<M = UnitTurnProtocol>
where M: TurnProtocol,
{ /* private fields */ }
Expand description

Sans-IO state machine for a single session run (multi-turn).

Implementations§

Source§

impl<M> TurnMachine<M>
where M: TurnProtocol,

Source

pub fn new( config: TurnMachineConfig<M>, messages: Vec<Message>, events: Arc<Vec<SessionEventRecord<<M as TurnProtocol>::Event>>>, protocol_run_offset: usize, ) -> TurnMachine<M>

Create a new machine in PrepareIteration state.

Source

pub fn new_shared( config: TurnMachineConfig<M>, messages: MessageSequence, events: Arc<Vec<SessionEventRecord<<M as TurnProtocol>::Event>>>, protocol_run_offset: usize, ) -> TurnMachine<M>

Source

pub fn new_shared_with_turn_causes( config: TurnMachineConfig<M>, messages: MessageSequence, events: Arc<Vec<SessionEventRecord<<M as TurnProtocol>::Event>>>, protocol_run_offset: usize, turn_causes: Vec<TurnCause>, ) -> TurnMachine<M>

Source

pub fn is_done(&self) -> bool

Whether the machine has finished.

Source

pub fn messages(&self) -> Arc<Vec<Message>>

Source

pub fn events(&self) -> Arc<Vec<SessionEventRecord<<M as TurnProtocol>::Event>>>

Source

pub fn message_sequence(&self) -> MessageSequence

Source

pub fn protocol_iteration(&self) -> usize

Source

pub fn checkpoint(&self) -> TurnCheckpoint<M>

Source

pub fn restore_from_checkpoint( config: TurnMachineConfig<M>, checkpoint: TurnCheckpoint<M>, ) -> TurnMachine<M>

Source

pub fn fail_turn(&mut self, event: SessionEvent)

Source

pub fn finish_with_outcome(&mut self, outcome: TurnOutcome)

Source

pub fn poll_effect(&mut self) -> Option<Effect<M>>

Drain the next pending effect. Returns None when the host must call handle_response() before more effects become available.

Source

pub fn apply_actions(&mut self, actions: Vec<DriverAction<M>>)

Source

pub fn handle_response(&mut self, response: Response)

Feed a response to a previously emitted effect.

Auto Trait Implementations§

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more