pub struct AdminProxy { /* private fields */ }

Implementations§

source§

impl AdminProxy

source

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.fshost/Admin.

source

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.

source

pub fn mount( &self, device: ClientEnd<BlockMarker>, name: &str, options: MountOptions ) -> QueryResponseFut<AdminMountResult>

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.

source

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

Unmounts a previously mounted filesystem.

source

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

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

source

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

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.

source

pub fn wipe_storage( &self, blobfs_root: Option<ServerEnd<DirectoryMarker>>, blob_creator: Option<ServerEnd<BlobCreatorMarker>> ) -> QueryResponseFut<AdminWipeStorageResult>

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.

source

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

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.

Trait Implementations§

source§

impl AdminProxyInterface for AdminProxy

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

source§

impl Clone for AdminProxy

source§

fn clone(&self) -> AdminProxy

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for AdminProxy

source§

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

Formats the value using the given formatter. Read more
source§

impl Proxy for AdminProxy

§

type Protocol = AdminMarker

The protocol which this Proxy controls.
source§

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.
source§

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel. Read more
source§

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel. Read more
§

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end. Read more
§

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.
§

fn on_closed(&self) -> OnSignals<'_>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more