Struct apis::session::Session

pub struct Session<CTX> where
    CTX: Context,  { /* fields omitted */ }

Implementations

impl<CTX> Session<CTX> where
    CTX: Context, 

pub fn report_sizes() where
    CTX: 'static, 

pub fn new(extended_state: ExtendedState<CTX>) -> Self

pub fn state(&self) -> &State

pub fn state_id(&self) -> StateId

pub fn state_data(&self) -> &StateData

pub fn extended_state(&self) -> &ExtendedState<CTX>

pub fn extended_state_mut(&mut self) -> &mut ExtendedState<CTX>

pub fn handle_event(
    &mut self,
    _event: Event<'_>
) -> Result<(), HandleEventException>

impl<CTX: Context> Session<CTX>

pub fn def(&self) -> &Def<CTX>

pub fn name(&self) -> &'static str

pub fn run(&mut self) -> VecMap<CTX::GPRES>

Creates a new session and runs to completion.

Transitions from Ready to Running, starts processes not already running (those present in the process_handles argument), waits for results and finally transitions to Ended.

pub fn run_with(
    &mut self,
    channels: VecMap<Channel<CTX>>,
    process_handles: VecMap<Handle<CTX>>,
    main_process: Option<Box<CTX::GPROC>>
) -> VecMap<CTX::GPRES>

Run a session with given channels and handles to processes that are running in a continuation from a previous session.

Trait Implementations

impl<CTX> AsMut<ExtendedState<CTX>> for Session<CTX> where
    CTX: Context, 

fn as_mut(&mut self) -> &mut ExtendedState<CTX>

Performs the conversion.

impl<CTX> AsRef<ExtendedState<CTX>> for Session<CTX> where
    CTX: Context, 

fn as_ref(&self) -> &ExtendedState<CTX>

Performs the conversion.

impl<CTX: Context> Debug for Session<CTX>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<CTX> Drop for Session<CTX> where
    CTX: Context, 

fn drop(&mut self)

Executes the destructor for this type.

impl<CTX: Context> From<Def<CTX>> for Session<CTX>

fn from(def: Def<CTX>) -> Self

Performs the conversion.

impl<CTX> MachineDotfile for Session<CTX> where
    CTX: Context, 

fn name() -> &'static str

fn type_vars() -> Vec<String>

fn extended_state_names() -> Vec<&'static str>

fn extended_state_types() -> Vec<&'static str>

fn extended_state_defaults() -> Vec<&'static str>

fn self_reference() -> &'static str

fn states() -> Vec<&'static str>

fn state_initial() -> &'static str

fn state_terminal() -> &'static str

fn state_data_names() -> Vec<Vec<&'static str>>

fn state_data_types() -> Vec<Vec<&'static str>>

fn state_data_defaults() -> Vec<Vec<&'static str>>

fn state_data_pretty_defaults() -> Vec<Vec<String>>

This version does not evaluate expressions, only pretty prints them

fn events() -> Vec<&'static str>

fn event_sources() -> Vec<&'static str>

fn event_targets() -> Vec<&'static str>

fn event_actions() -> Vec<&'static str>

fn dotfile() -> String

Generate a DOT file for the state machine that hides default expressions for state fields and extended state fields, but shows event actions

fn dotfile_show_defaults() -> String

Generate a DOT file for the state machine that shows default expressions for state fields and extended state fields

fn dotfile_pretty_defaults() -> String

Generate a DOT file for the state machine that pretty prints the values of default expressions for state fields and extended state fields.

fn dotfile_hide_actions() -> String

Do not show event actions