Struct VolumeManagerProxy

pub struct VolumeManagerProxy { /* private fields */ }

Implementations

impl VolumeManagerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.block.volume/VolumeManager.

pub fn take_event_stream(&self) -> VolumeManagerEventStream

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

Panics

Panics if the event stream was already taken.

pub fn allocate_partition( &self, slice_count: u64, type_: &Guid, instance: &Guid, name: &str, flags: u32, ) -> QueryResponseFut<i32, DefaultFuchsiaResourceDialect>

Allocates a virtual partition with the requested features.

slice_count is the number of slices initially allocated to the partition, at offset zero. The number of slices allocated to a new partition must be at least one. type and value indicate type and instance GUIDs for the partition, respectively. name indicates the name of the new partition.

pub fn get_info( &self, ) -> QueryResponseFut<(i32, Option<Box<VolumeManagerInfo>>), DefaultFuchsiaResourceDialect>

Gets the VolumeManagerInfo describing this instance of the VolumeManager.

NOTE: GetInfo() is used to synchronize child partition device visibility with devfs. Implementations must only respond once all child partitions of VolumeManager have been added to devfs, to guarantee clients can safely enumerate them.

See https://fxbug.dev/42077585 for more information.

pub fn activate( &self, old_guid: &Guid, new_guid: &Guid, ) -> QueryResponseFut<i32, DefaultFuchsiaResourceDialect>

Atomically marks a vpartition (by instance GUID) as inactive, while finding another partition (by instance GUID) and marking it as active.

If the “old” partition does not exist, the GUID is ignored. If the “old” partition is the same as the “new” partition, the “old” GUID is ignored. If the “new” partition does not exist, ZX_ERR_NOT_FOUND is returned.

This function does not destroy the “old” partition, it just marks it as inactive – to reclaim that space, the “old” partition must be explicitly destroyed. This destruction can also occur automatically when the FVM driver is rebound (i.e., on reboot).

This function may be useful for A/B updates within the FVM, since it will allow activating updated partitions.

pub fn get_partition_limit( &self, guid: &Guid, ) -> QueryResponseFut<(i32, u64), DefaultFuchsiaResourceDialect>

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

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

Currently the partition limit is not persisted across reboots but this may change in the future.

pub fn set_partition_limit( &self, guid: &Guid, slice_count: u64, ) -> QueryResponseFut<i32, DefaultFuchsiaResourceDialect>

Sets the allocation limit for the partition. Partitions can not be extended beyond their allocation limit. The partition limit will never shrink partitions so if this value is less than the current partition size, it will keep the current size but prevent further growth.

The allocation limits are on the VolumeManager API rather than on the partition because they represent a higher capability level. These limits are designed to put guards on users of the block device (and hence the Volume API).

Currently the partition limit is not persisted across reboots but this may change in the future.

pub fn set_partition_name( &self, guid: &Guid, name: &str, ) -> QueryResponseFut<VolumeManagerSetPartitionNameResult, DefaultFuchsiaResourceDialect>

Renames the specified partition. Any existing devices that include the name of the partition in their topological path might not reflect the name change until the next time that the device is instantiated.

Trait Implementations

impl Clone for VolumeManagerProxy

fn clone(&self) -> VolumeManagerProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VolumeManagerProxy

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

Formats the value using the given formatter.

impl Proxy for VolumeManagerProxy

type Protocol = VolumeManagerMarker

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 VolumeManagerProxyInterface for VolumeManagerProxy

type AllocatePartitionResponseFut = QueryResponseFut<i32>

type GetInfoResponseFut = QueryResponseFut<(i32, Option<Box<VolumeManagerInfo>>)>

type ActivateResponseFut = QueryResponseFut<i32>

type GetPartitionLimitResponseFut = QueryResponseFut<(i32, u64)>

type SetPartitionLimitResponseFut = QueryResponseFut<i32>

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

fn allocate_partition( &self, slice_count: u64, type_: &Guid, instance: &Guid, name: &str, flags: u32, ) -> Self::AllocatePartitionResponseFut

fn get_info(&self) -> Self::GetInfoResponseFut

fn activate( &self, old_guid: &Guid, new_guid: &Guid, ) -> Self::ActivateResponseFut

fn get_partition_limit(&self, guid: &Guid) -> Self::GetPartitionLimitResponseFut

fn set_partition_limit( &self, guid: &Guid, slice_count: u64, ) -> Self::SetPartitionLimitResponseFut

fn set_partition_name( &self, guid: &Guid, name: &str, ) -> Self::SetPartitionNameResponseFut