Struct AdminSynchronousProxy 

pub struct AdminSynchronousProxy { /* private fields */ }

Implementations

impl AdminSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<AdminEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn power_fully_on( &self, ___deadline: MonotonicInstant, ) -> Result<AdminPowerFullyOnResult, Error>

Asks the device to enter a fully on state.

pub fn shutdown( &self, options: &ShutdownOptions, ___deadline: MonotonicInstant, ) -> Result<AdminShutdownResult, Error>

Asks the device to enter the state specified by options.action.

Arguments:

• options: The options with which to perform this request. ZX_ERR_INVALID_ARGS is returned if action is absent. reasons may be omitted, but adding a new enum value instead is strongly encouraged.

pub fn reboot( &self, reason: RebootReason, ___deadline: MonotonicInstant, ) -> Result<AdminRebootResult, Error>

Asks the device to reboot.

Replaced by PerformReboot.

pub fn perform_reboot( &self, options: &RebootOptions, ___deadline: MonotonicInstant, ) -> Result<AdminPerformRebootResult, Error>

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).

Deprecation

Use Shutdown, which allows callers to specify the intended action and reasons for the action.

pub fn reboot_to_bootloader( &self, ___deadline: MonotonicInstant, ) -> Result<AdminRebootToBootloaderResult, Error>

Asks the device to reboot into the bootloader.

Deprecation

Use Shutdown, which allows callers to specify reasons why they are requesting a reboot to bootloader.

pub fn reboot_to_recovery( &self, ___deadline: MonotonicInstant, ) -> Result<AdminRebootToRecoveryResult, Error>

Asks the device to reboot into the recovery partition.

Deprecation

Use Shutdown, which allows callers to specify reasons why they are requesting a reboot to recovery.

pub fn poweroff( &self, ___deadline: MonotonicInstant, ) -> Result<AdminPoweroffResult, Error>

Asks all devices to enter a powered off state.

Deprecation

Use Shutdown, which allows callers to specify reasons why they are requesting a poweroff.

pub fn mexec( &self, kernel_zbi: Vmo, data_zbi: Vmo, ___deadline: MonotonicInstant, ) -> Result<AdminMexecResult, Error>

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, ___deadline: MonotonicInstant, ) -> Result<AdminSuspendToRamResult, Error>

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 Debug for AdminSynchronousProxy

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

Formats the value using the given formatter.

impl From<AdminSynchronousProxy> for NullableHandle

Available on Fuchsia only.

fn from(value: AdminSynchronousProxy) -> Self

Converts to this type from the input type.

impl From<Channel> for AdminSynchronousProxy

Available on Fuchsia only.

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl FromClient for AdminSynchronousProxy

Available on Fuchsia only.

type Protocol = AdminMarker

The protocol.

fn from_client(value: ClientEnd<AdminMarker>) -> Self

Converts from a client.

impl SynchronousProxy for AdminSynchronousProxy

Available on Fuchsia only.

type Proxy = AdminProxy

The async proxy for the same protocol.

type Protocol = AdminMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.