Enum LifecycleRequest

pub enum LifecycleRequest {
    Start {
        payload: LifecycleStartRequest,
        responder: LifecycleStartResponder,
    },
    Stop {
        responder: LifecycleStopResponder,
    },
    Restart {
        responder: LifecycleRestartResponder,
    },
    _UnknownMethod {
        ordinal: u64,
        control_handle: LifecycleControlHandle,
        method_type: MethodType,
    },
}

A protocol used to control the session’s lifecycle.

Variants

Start

Starts the session.

Returns after the session component has been created and started.

• error LifecycleError.NOT_FOUND if session_url has not been provided and there is no configured default session URL.
• error LifecycleError.ALREADY_STARTED if a session has already been started.
• error LifecycleError.RESOLVE_COMPONENT_FAILED if session_url could not be resolved to a component.
• error LifecycleError.DESTROY_COMPONENT_FAILED if an existing session component could not be destroyed. The existing session remains running at this point.
• error LifecycleError.CREATE_COMPONENT_FAILED if the session component could not be started. No session will be running at this point.

Fields

payload: LifecycleStartRequest

responder: LifecycleStartResponder

Stop

Stops the session.

Returns after the session component has been destroyed.

• error LifecycleError.NOT_FOUND if the session has not been started.
• error LifecycleError.DESTROY_COMPONENT_FAILED if the session component could not be destroyed. The previous session will continue to exist at this point and the component may be running.

Fields

responder: LifecycleStopResponder

Restart

Restarts the session.

This stops the existing session and starts a new session with the same session URL as the previous one.

Returns once the new session component has been created and started.

• error LifecycleError.NOT_FOUND if there is no existing session.
• error LifecycleError.RESOLVE_COMPONENT_FAILED if the session URL could not be resolved to a component.
• error LifecycleError.DESTROY_COMPONENT_FAILED if the session component could not be destroyed. The previous session will continue to exist at this point and the component may be running.
• error LifecycleError.CREATE_COMPONENT_FAILED if the session component could not be started. No session will be running at this point.

Fields

responder: LifecycleRestartResponder

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: LifecycleControlHandle

method_type: MethodType

Implementations

impl LifecycleRequest

pub fn into_start( self, ) -> Option<(LifecycleStartRequest, LifecycleStartResponder)>

pub fn into_stop(self) -> Option<LifecycleStopResponder>

pub fn into_restart(self) -> Option<LifecycleRestartResponder>

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

Name of the method defined in FIDL

Trait Implementations

impl Debug for LifecycleRequest

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

Formats the value using the given formatter.