Struct ClientConfiguratorProxy

pub struct ClientConfiguratorProxy { /* private fields */ }

Implementations

impl ClientConfiguratorProxy

pub fn new(channel: AsyncChannel) -> Self

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

pub fn take_event_stream(&self) -> ClientConfiguratorEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get( &self, client_type: ClientType, ) -> QueryResponseFut<Option<Box<ClientConfig>>, DefaultFuchsiaResourceDialect>

Gets the power configuration for the given [ClientType].

If there is no power configuration for client_type then the returned value will be absent.

• client_type specifies which [ClientType] ClientConfig to get

• config is the returned client-specific configuration, or an absent value if client_type does not have an existing configuration

pub fn set( &self, client_type: ClientType, config: &ClientConfig, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Sets the power configuration for the given [ClientType].

This method should be used in tandem with [GetConfig] in order to update the existing power configuration for a given [ClientType] without fully overwriting it.

When the power configuration for a given [ClientType] is changed, the Power Manager will reevaluate current power level of that [ClientType] according to the new configuration. This reevaluation may result in a new power level being sent to the connected client.

The call returns immediately after the new config has been received and validated. Actual system changes to be applied as a result of changing a client’s configuration 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.

If the provided config is not valid, then no changes will be applied and the channel will be closed. Validation will fail if a given SystemMode is repeated across multiple mode_match entries contained by the ClientConfig.

• client_type specifies which [ClientType]’s ClientConfig to set
• config is the ClientConfig that will be set for [client_type]

Trait Implementations

impl ClientConfiguratorProxyInterface for ClientConfiguratorProxy

type GetResponseFut = QueryResponseFut<Option<Box<ClientConfig>>>

type SetResponseFut = QueryResponseFut<()>

fn get(&self, client_type: ClientType) -> Self::GetResponseFut

fn set( &self, client_type: ClientType, config: &ClientConfig, ) -> Self::SetResponseFut

impl Clone for ClientConfiguratorProxy

fn clone(&self) -> ClientConfiguratorProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfiguratorProxy

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

Formats the value using the given formatter.

impl Proxy for ClientConfiguratorProxy

type Protocol = ClientConfiguratorMarker

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.