Struct AdminProxy

pub struct AdminProxy { /* private fields */ }

Implementations

impl AdminProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.fshost/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 mount( &self, device: ClientEnd<BlockMarker>, name: &str, options: MountOptions, ) -> QueryResponseFut<AdminMountResult, DefaultFuchsiaResourceDialect>

Mounts the filesystem on the block device. The filesystem will be mounted in /fs/mnt/ (in fshost’s outgoing directory). This may or may not be supported depending on fshost configuration.

pub fn unmount( &self, name: &str, ) -> QueryResponseFut<AdminUnmountResult, DefaultFuchsiaResourceDialect>

Unmounts a previously mounted filesystem.

pub fn get_device_path( &self, fs_id: u64, ) -> QueryResponseFut<AdminGetDevicePathResult, DefaultFuchsiaResourceDialect>

Returns the device path for the filesystem with the given fs_id.

pub fn write_data_file( &self, filename: &str, payload: Vmo, ) -> QueryResponseFut<AdminWriteDataFileResult, 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 wipe_storage( &self, blobfs_root: Option<ServerEnd<DirectoryMarker>>, blob_creator: Option<ServerEnd<BlobCreatorMarker>>, ) -> QueryResponseFut<AdminWipeStorageResult, DefaultFuchsiaResourceDialect>

Reprovision the first non-ramdisk FVM volume, and format/mount the blob partition. The formatted Blobfs instance can be accessed via the client end of blobfs_root; if no handle is provided, then blobfs won’t be formatted.

If fxblob is configured, blob_creator will be connected with the fxfs BlobCreator protocol, which should be used instead of creating blobs in the blobfs_root. blobfs_root will still be connected and can be used to read blobs. If fxblob is configured, but no handle is provided for blob_creator or for blobfs_root, the blob volume won’t be formatted. If a handle is provided for blob_creator but fxblob is not configured, the channel will be closed.

This function will pause the fshost block watcher regardless of success or failure. Requires fshost to be started with the ramdisk_image config option set to true.

WARNING: This will cause irreversible data loss. Use with caution.

TODO(https://fxbug.dev/42063480): This function unbinds all child drivers of the volume to be wiped. This can race with the fshost block device manager, which attempts to bind the FVM driver and unseal the zxcrypt volume.

pub fn shred_data_volume( &self, ) -> QueryResponseFut<AdminShredDataVolumeResult, DefaultFuchsiaResourceDialect>

Wipes the data volume which will get reinitialised upon next boot. This is not cryptographically secure; the caller should take care to reset hardware keys.

pub fn storage_host_enabled( &self, ) -> QueryResponseFut<bool, DefaultFuchsiaResourceDialect>

Returns whether fshost is configured to use storage-host.

Trait Implementations

impl AdminProxyInterface for AdminProxy

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

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

type GetDevicePathResponseFut = QueryResponseFut<Result<String, i32>>

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

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

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

type StorageHostEnabledResponseFut = QueryResponseFut<bool>

fn mount( &self, device: ClientEnd<BlockMarker>, name: &str, options: MountOptions, ) -> Self::MountResponseFut

fn unmount(&self, name: &str) -> Self::UnmountResponseFut

fn get_device_path(&self, fs_id: u64) -> Self::GetDevicePathResponseFut

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

fn wipe_storage( &self, blobfs_root: Option<ServerEnd<DirectoryMarker>>, blob_creator: Option<ServerEnd<BlobCreatorMarker>>, ) -> Self::WipeStorageResponseFut

fn shred_data_volume(&self) -> Self::ShredDataVolumeResponseFut

fn storage_host_enabled(&self) -> Self::StorageHostEnabledResponseFut

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.