Struct fidl_fuchsia_fxfs::VolumeProxy

pub struct VolumeProxy { /* private fields */ }

Implementations

impl VolumeProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.fxfs/Volume.

pub fn take_event_stream(&self) -> VolumeEventStream

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, outgoing_directory: ServerEnd<DirectoryMarker>, options: MountOptions ) -> QueryResponseFut<VolumeMountResult>

Mounts the volume. If the volume is encrypted, options.crypt should provide all key access for the given volume. outgoing_directory will contain the root and other services exposed by the volume. To lock the volume, call fuchsia.fs.Admin.Shutdown on the returned handle.

pub fn check( &self, options: CheckOptions ) -> QueryResponseFut<VolumeCheckResult>

Check the volume for consistency. If the volume is encrypted, options.crypt should provide all key access for the given volume.

pub fn set_limit(&self, bytes: u64) -> QueryResponseFut<VolumeSetLimitResult>

Set the limit in bytes on the volume. Setting it lower than current usage is accepted but will prevent further increases.

pub fn get_limit(&self) -> QueryResponseFut<VolumeGetLimitResult>

Get the allocation limit for the volume. A return value of 0 indicates that there is no limit and the volume can be extended as long as there is available space on the device.

The volume may be larger than this limit if a smaller limit was applied after the volume had already grown to the current size.

The volume limit persists across reboots.

Trait Implementations

impl Clone for VolumeProxy

fn clone(&self) -> VolumeProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VolumeProxy

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

Formats the value using the given formatter.

impl Proxy for VolumeProxy

type Protocol = VolumeMarker

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 VolumeProxyInterface for VolumeProxy

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

fn mount( &self, outgoing_directory: ServerEnd<DirectoryMarker>, options: MountOptions ) -> Self::MountResponseFut

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

fn check(&self, options: CheckOptions) -> Self::CheckResponseFut

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

fn set_limit(&self, bytes: u64) -> Self::SetLimitResponseFut

type GetLimitResponseFut = QueryResponseFut<Result<u64, i32>>

fn get_limit(&self) -> Self::GetLimitResponseFut