Struct apis::example::session_a::Upcase

pub struct Upcase {
    pub history: String,
    /* private fields */
}

Fields

history: String

Trait Implementations

impl From<Upcase> for GlobalProcess

fn from(process: Upcase) -> Self

Converts to this type from the input type.

impl Process<SessionA, ()> for Upcase

fn new(inner: Inner<SessionA>) -> Self

fn extract_result(
    session_results: &mut VecMap<GlobalPresult>
) -> Result<(), String>

fn inner_ref(&self) -> &Inner<SessionA>

fn inner_mut(&mut self) -> &mut Inner<SessionA>

fn result_ref(&self) -> &()

fn result_mut(&mut self) -> &mut ()

fn global_result(&mut self) -> GlobalPresult

fn handle_message(&mut self, message: GlobalMessage) -> ControlFlow

fn update(&mut self) -> ControlFlow

fn initialize(&mut self)

Does nothing by default, may be overridden.

fn terminate(&mut self)

Does nothing by default, may be overridden.

fn id(&self) -> &CTX::PID where
    CTX: 'static, 

fn kind(&self) -> &Kind where
    CTX: 'static, 

fn state_id(&self) -> StateId

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

fn sourcepoints(&self) -> &VecMap<Box<dyn Sourcepoint<CTX>>>

fn sourcepoints_mut(&mut self) -> &mut VecMap<Box<dyn Sourcepoint<CTX>>>

fn endpoints(&self) -> Ref<'_, Option<VecMap<Box<dyn Endpoint<CTX>>>>>

This method returns a Ref <Option <...>> because during the run loop the endpoints will be unavailable as they are being iterated over. Endpoints are automatically waited on or polled in the appropriate run_* function. Endpoints will be present for the calls to terminate or initialize, either before or after the run loop, respectively.

fn endpoints_mut(
    &mut self
) -> RefMut<'_, Option<VecMap<Box<dyn Endpoint<CTX>>>>>

This method returns a Ref <Option <...>> because during the run loop the endpoints will be unavailable as they are being iterated over. Endpoints are automatically waited on or polled in the appropriate run_* function. Endpoints will be present for the calls to terminate or initialize, either before or after the run loop, respectively.

fn take_endpoints(&self) -> VecMap<Box<dyn Endpoint<CTX>>>

This method is used within the process run_* methods to get the endpoints without borrowing the process. Endpoints will then be replaced with None and unavailable within the run loop.

fn put_endpoints(&self, endpoints: VecMap<Box<dyn Endpoint<CTX>>>)

Errors

fn send<M: Message<CTX>>(
    &self,
    channel_id: CTX::CID,
    message: M
) -> Result<(), SendError<CTX::GMSG>> where
    CTX: 'static, 

fn send_to<M: Message<CTX>>(
    &self,
    channel_id: CTX::CID,
    recipient: CTX::PID,
    message: M
) -> Result<(), SendError<CTX::GMSG>> where
    CTX: 'static, 

fn run(&mut self) where
    Self: Sized + 'static,
    CTX: 'static, 

Run a process to completion and send the result on the result channel.

fn run_continue(self) -> Option<()> where
    Self: Sized + 'static,
    CTX: 'static, 

Run a process to completion, send the result to the session, and proceed with the continuation received from the session.

fn run_asynchronous(&mut self) where
    Self: Sized,
    CTX: 'static, 

Asynchronous run loop waits for messages on the single endpoint held by this process and calls the process update method for every $n >= 1$ messages as specified by the process kind.

fn run_isochronous(&mut self) where
    Self: Sized,
    CTX: 'static, 

This function implements a fixed-timestep update loop.

fn run_mesochronous(&mut self) where
    Self: Sized,
    CTX: 'static, 

This function implements a rate-limited update loop.

fn run_anisochronous(&mut self) where
    Self: Sized,
    CTX: 'static, 

An un-timed run loop that polls for messages.

impl TryFrom<GlobalProcess> for Upcase

type Error = String

The type returned in the event of a conversion error.

fn try_from(global_process: GlobalProcess) -> Result<Self, Self::Error>

Performs the conversion.

impl Presult<SessionA, Upcase> for ()