Struct fidl_fuchsia_session::LifecycleProxy

pub struct LifecycleProxy { /* private fields */ }

Implementations

impl LifecycleProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.session/Lifecycle.

pub fn take_event_stream(&self) -> LifecycleEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn start( &self, payload: &LifecycleStartRequest ) -> QueryResponseFut<LifecycleStartResult>

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.

pub fn stop(&self) -> QueryResponseFut<LifecycleStopResult>

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.

pub fn restart(&self) -> QueryResponseFut<LifecycleRestartResult>

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.

Trait Implementations

impl Clone for LifecycleProxy

fn clone(&self) -> LifecycleProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LifecycleProxy

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

Formats the value using the given formatter.

impl LifecycleProxyInterface for LifecycleProxy

type StartResponseFut = QueryResponseFut<Result<(), LifecycleError>>

fn start(&self, payload: &LifecycleStartRequest) -> Self::StartResponseFut

type StopResponseFut = QueryResponseFut<Result<(), LifecycleError>>

fn stop(&self) -> Self::StopResponseFut

type RestartResponseFut = QueryResponseFut<Result<(), LifecycleError>>

fn restart(&self) -> Self::RestartResponseFut

impl Proxy for LifecycleProxy

type Protocol = LifecycleMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.