Struct RecoveryProxy 

pub struct RecoveryProxy { /* private fields */ }

Implementations

impl RecoveryProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.fshost/Recovery.

pub fn take_event_stream(&self) -> RecoveryEventStream

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

Panics

Panics if the event stream was already taken.

pub fn init_system_partition_table( &self, partitions: &[PartitionInfo], ) -> QueryResponseFut<RecoveryInitSystemPartitionTableResult, DefaultFuchsiaResourceDialect>

Wipes and re-initializes the system partition table. This is a destructive operation!

pub fn write_data_file( &self, filename: &str, payload: Vmo, ) -> QueryResponseFut<RecoveryWriteDataFileResult, DefaultFuchsiaResourceDialect>

Writes filename into the data partition with contents from payload, formatting the data partition if it isn’t already formatted. Overwrites file if it already exists.

This can only be called while the data partition isn’t already mounted, which is typically in recovery builds where fshost is running with the ramdisk_image flag set.

pub fn format_system_blob_volume( &self, ) -> QueryResponseFut<RecoveryFormatSystemBlobVolumeResult, DefaultFuchsiaResourceDialect>

Formats the blob volume in the system container. If the system container does not have a blob volume, a new one will be created. All existing blobs will be deleted. If the system container is corrupt or unmountable, this function will have no effect and will leave the disk intact.

WARNING: This can cause irreversible data loss and can render a device unbootable.

pub fn mount_system_blob_volume( &self, blob_exposed_dir: ServerEnd<DirectoryMarker>, ) -> QueryResponseFut<RecoveryMountSystemBlobVolumeResult, DefaultFuchsiaResourceDialect>

Mounts the system container’s blob volume, and returns a handle to the blob volume’s exposed directory to facilitate writing a new system. The system container will remain mounted as long as blob_exposed_dir is kept open. Only the blob volume will be mounted.

pub fn get_blob_image_handle( &self, ) -> QueryResponseFut<RecoveryGetBlobImageHandleResult, DefaultFuchsiaResourceDialect>

Obtains a handle to a file where a new system blob volume can be written. The contents of the file must be a valid fxfs partition image containing a blob volume. The existing blob volume will remain unmodified until the system is rebooted, or InstallBlobImage is called. The system container will remain mounted as long as mount_token is kept open. NOTE: This method will delete any existing image data cached on disk. Callers are responsible for keeping the returned image_file and mount_token alive until the system image has been fully written and flushed to disk.

Errors

• ZX_ERR_IO_DATA_INTEGRITY: An existing filesystem was found on the device, but it could not be mounted. This indicates that the filesystem is possibly corrupt, or has a newer on-disk version than the recovery image. To avoid unintended data loss, the user should explicitly initiate any remedial action, such as wiping the device or using a newer image.
• ZX_ERR_INTERNAL: An internal error occured; see fshost logs for more context.

pub fn install_blob_image( &self, ) -> QueryResponseFut<RecoveryInstallBlobImageResult, DefaultFuchsiaResourceDialect>

Installs the blob volume previously written via GetBlobImageHandle, replacing the existing blob volume in the system container. On failure, the existing blob volume will remain intact, and the written image will be deleted to free space. A new blob image can then be written and the installation process restarted. If no blob volume has been written, this will have no effect. This function will block until the system container is unmounted.

Trait Implementations

impl Clone for RecoveryProxy

fn clone(&self) -> RecoveryProxy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecoveryProxy

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

Formats the value using the given formatter.

impl Proxy for RecoveryProxy

type Protocol = RecoveryMarker

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 RecoveryProxyInterface for RecoveryProxy

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

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

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

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

type GetBlobImageHandleResponseFut = QueryResponseFut<Result<RecoveryGetBlobImageHandleResponse, i32>>

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

fn init_system_partition_table( &self, partitions: &[PartitionInfo], ) -> Self::InitSystemPartitionTableResponseFut

fn write_data_file( &self, filename: &str, payload: Vmo, ) -> Self::WriteDataFileResponseFut

fn format_system_blob_volume(&self) -> Self::FormatSystemBlobVolumeResponseFut

fn mount_system_blob_volume( &self, blob_exposed_dir: ServerEnd<DirectoryMarker>, ) -> Self::MountSystemBlobVolumeResponseFut

fn get_blob_image_handle(&self) -> Self::GetBlobImageHandleResponseFut

fn install_blob_image(&self) -> Self::InstallBlobImageResponseFut