Struct AdminProxy

pub struct AdminProxy { /* private fields */ }

Implementations

impl AdminProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.power.statecontrol/Admin.

pub fn take_event_stream(&self) -> AdminEventStream

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

Panics

Panics if the event stream was already taken.

pub fn power_fully_on( &self, ) -> QueryResponseFut<AdminPowerFullyOnResult, DefaultFuchsiaResourceDialect>

Asks the device to enter a fully on state.

pub fn reboot( &self, reason: RebootReason, ) -> QueryResponseFut<AdminRebootResult, DefaultFuchsiaResourceDialect>

Asks the device to reboot.

Replaced by PerformReboot.

pub fn perform_reboot( &self, options: &RebootOptions, ) -> QueryResponseFut<AdminPerformRebootResult, DefaultFuchsiaResourceDialect>

Asks the device to reboot.

Arguments:

• options: The options with which to perform this requests. ZX_ERR_INVALID_ARGS is returned if the options are malformed (i.e. reasons is absent or empty).

pub fn reboot_to_bootloader( &self, ) -> QueryResponseFut<AdminRebootToBootloaderResult, DefaultFuchsiaResourceDialect>

Asks the device to reboot into the bootloader.

pub fn reboot_to_recovery( &self, ) -> QueryResponseFut<AdminRebootToRecoveryResult, DefaultFuchsiaResourceDialect>

Asks the device to reboot into the recovery partition.

pub fn poweroff( &self, ) -> QueryResponseFut<AdminPoweroffResult, DefaultFuchsiaResourceDialect>

Asks all devices to enter a powered off state.

pub fn mexec( &self, kernel_zbi: Vmo, data_zbi: Vmo, ) -> QueryResponseFut<AdminMexecResult, DefaultFuchsiaResourceDialect>

Performs a kernel mexec.

It is expected that the ZBI items specified by zx_system_mexec_payload_get() have not yet been appended to the provided data ZBI.

pub fn suspend_to_ram( &self, ) -> QueryResponseFut<AdminSuspendToRamResult, DefaultFuchsiaResourceDialect>

Asks the device to enter the suspend to RAM (S3) power state. Currently only supported on x64. If a system state transition is already in progress then ZX_ERR_ALREADY_EXISTS is returned. If the device fails to reach the suspend power state then ZX_ERR_INTERNAL is returned. If the device successfully suspends, ZX_OK is returned when the device resumes.

Trait Implementations

impl AdminProxyInterface for AdminProxy

type PowerFullyOnResponseFut = QueryResponseFut<Result<(), i32>>

type RebootResponseFut = QueryResponseFut<Result<(), i32>>

type PerformRebootResponseFut = QueryResponseFut<Result<(), i32>>

type RebootToBootloaderResponseFut = QueryResponseFut<Result<(), i32>>

type RebootToRecoveryResponseFut = QueryResponseFut<Result<(), i32>>

type PoweroffResponseFut = QueryResponseFut<Result<(), i32>>

type MexecResponseFut = QueryResponseFut<Result<(), i32>>

type SuspendToRamResponseFut = QueryResponseFut<Result<(), i32>>

fn power_fully_on(&self) -> Self::PowerFullyOnResponseFut

fn reboot(&self, reason: RebootReason) -> Self::RebootResponseFut

fn perform_reboot( &self, options: &RebootOptions, ) -> Self::PerformRebootResponseFut

fn reboot_to_bootloader(&self) -> Self::RebootToBootloaderResponseFut

fn reboot_to_recovery(&self) -> Self::RebootToRecoveryResponseFut

fn poweroff(&self) -> Self::PoweroffResponseFut

fn mexec(&self, kernel_zbi: Vmo, data_zbi: Vmo) -> Self::MexecResponseFut

fn suspend_to_ram(&self) -> Self::SuspendToRamResponseFut

impl Clone for AdminProxy

fn clone(&self) -> AdminProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdminProxy

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

Formats the value using the given formatter.

impl Proxy for AdminProxy

type Protocol = AdminMarker

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.