Struct fidl_fuchsia_power_systemmode::RequesterProxy

pub struct RequesterProxy { /* private fields */ }

Implementations

impl RequesterProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.power.systemmode/Requester.

pub fn take_event_stream(&self) -> RequesterEventStream

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

Panics

Panics if the event stream was already taken.

pub fn request( &self, mode: SystemMode, set: bool ) -> QueryResponseFut<RequesterRequestResult>

Requests to set or clear a system power mode.

The call returns immediately after the request has been received, validated, and accepted. Actual system changes to be applied as a result of this request will occur after the call has returned. Therefore, any errors that occur while updating clients according to the new system power mode are not propagated back to the caller. Instead, client updates are applied on a “best effort” basis.

An error returned by this method means the request itself is not valid and was rejected. Details of the specific rejection reason are reflected by the error value. In the event of an error, the channel will remain open.

A client can use this method to set or clear system power mode variants independently. For example:

// battery is below the “low” threshold Request(LOW_BATTERY, true);

// device is now plugged into the wall Request(ON_AC_POWER, true);

// battery is now above the “low” threshold Request(LOW_BATTERY, false);

• mode is the SystemMode to request to be set or cleared
• set should be true to request to set mode, or false to clear it

• error a ModeRequestError value indicating why the request was rejected.

Trait Implementations

impl Clone for RequesterProxy

fn clone(&self) -> RequesterProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RequesterProxy

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

Formats the value using the given formatter.

impl Proxy for RequesterProxy

type Protocol = RequesterMarker

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.

impl RequesterProxyInterface for RequesterProxy

type RequestResponseFut = QueryResponseFut<Result<(), ModeRequestError>>

fn request(&self, mode: SystemMode, set: bool) -> Self::RequestResponseFut