pub struct VolumeAndNodeProxy { /* private fields */ }

Implementations§

source§

impl VolumeAndNodeProxy

source

pub fn new(channel: AsyncChannel) -> Self

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

source

pub fn take_event_stream(&self) -> VolumeAndNodeEventStream

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

§Panics

Panics if the event stream was already taken.

source

pub fn get_info(&self) -> QueryResponseFut<BlockGetInfoResult>

Get information about the underlying block device.

source

pub fn get_stats(&self, clear: bool) -> QueryResponseFut<BlockGetStatsResult>

Returns stats about block device operations. Setting clear will reset stats counters.

source

pub fn open_session( &self, session: ServerEnd<SessionMarker> ) -> Result<(), Error>

Opens a new FIFO-based session on the block device.

source

pub fn read_blocks( &self, vmo: Vmo, length: u64, dev_offset: u64, vmo_offset: u64 ) -> QueryResponseFut<BlockReadBlocksResult>

Reads from a block device.

This read does not require exclusive access. length, dev_offset and vmo_offset are specified in bytes, but they must be block-aligned. This method is provided for backward compatibility, and is not intended for new code. New code should use the FIFO interface along with the client libraries to read and write from block devices.

source

pub fn write_blocks( &self, vmo: Vmo, length: u64, dev_offset: u64, vmo_offset: u64 ) -> QueryResponseFut<BlockWriteBlocksResult>

Writes to a block device.

This write does not require exclusive access. length, dev_offset and vmo_offset are specified in bytes, but they must be block-aligned. This method is provided for backward compatibility, and is not intended for new code. New code should use the FIFO interface along with the client libraries to read and write from block devices.

source

pub fn get_type_guid(&self) -> QueryResponseFut<(i32, Option<Box<Guid>>)>

Gets the type GUID of the partition (if one exists). If the partition has no type GUID, ZX_ERR_NOT_SUPPORTED is returned.

source

pub fn get_instance_guid(&self) -> QueryResponseFut<(i32, Option<Box<Guid>>)>

Gets the instance GUID of the partition (if one exists). If the partition has no instance GUID, ZX_ERR_NOT_SUPPORTED is returned.

source

pub fn get_name(&self) -> QueryResponseFut<(i32, Option<String>)>

Gets the name of the partition (if one exists). If the partition has no name, ZX_ERR_NOT_SUPPORTED is returned.

source

pub fn query_slices( &self, start_slices: &[u64] ) -> QueryResponseFut<(i32, [VsliceRange; 16], u64)>

Returns the number of contiguous allocated (or unallocated) vslices starting from each vslice.

source

pub fn get_volume_info( &self ) -> QueryResponseFut<(i32, Option<Box<VolumeManagerInfo>>, Option<Box<VolumeInfo>>)>

Returns the information about this volume and the volume manager it is embedded in.

source

pub fn extend( &self, start_slice: u64, slice_count: u64 ) -> QueryResponseFut<i32>

Extends the mapping of this partition.

The ability to extend the partition is dependent on having sufficient free space on the underlying device, having sufficient free slots for tracking the bytes in the volume manager header, and the partition limit (see VolumeManager.SetPartitionLimit).

source

pub fn shrink( &self, start_slice: u64, slice_count: u64 ) -> QueryResponseFut<i32>

Shrinks a virtual partition. Returns ZX_OK if ANY slices are freed, even if part of the requested range contains unallocated slices.

source

pub fn destroy(&self) -> QueryResponseFut<i32>

Destroys the current partition, removing it from the VolumeManager, and freeing all underlying storage. The connection to the volume is also closed.

source

pub fn clone( &self, flags: OpenFlags, object: ServerEnd<NodeMarker> ) -> Result<(), Error>

Create another connection to the same remote object.

flags may be any of:

  • OpenFlags.RIGHT_*
  • OpenFlags.APPEND
  • OpenFlags.DESCRIBE
  • OpenFlags.CLONE_SAME_RIGHTS

All other flags are ignored.

The OpenFlags.RIGHT_* bits in flags request corresponding rights over the resulting cloned object. The cloned object must have rights less than or equal to the original object, otherwise returns ZX_ERR_ACCESS_DENIED. Alternatively, pass OpenFlags.CLONE_SAME_RIGHTS to inherit the rights on the source connection. It is invalid to pass any of the OpenFlags.RIGHT_* flags together with OpenFlags.CLONE_SAME_RIGHTS.

source

pub fn get_attr(&self) -> QueryResponseFut<(i32, NodeAttributes)>

Acquires information about the node.

This method does not require any rights.

source

pub fn set_attr( &self, flags: NodeAttributeFlags, attributes: &NodeAttributes ) -> QueryResponseFut<i32>

Updates information about the node.

This method requires following rights: OpenFlags.RIGHT_WRITABLE, otherwise returns ZX_ERR_BAD_HANDLE.

source

pub fn get_flags(&self) -> QueryResponseFut<(i32, OpenFlags)>

Acquires the Directory.Open rights and flags used to access this file.

This method does not require any rights.

source

pub fn set_flags(&self, flags: OpenFlags) -> QueryResponseFut<i32>

Changes the Directory.Open flags used to access the file. Supported flags which can be turned on / off:

  • OpenFlags.APPEND

This method does not require any rights.

source

pub fn query_filesystem( &self ) -> QueryResponseFut<(i32, Option<Box<FilesystemInfo>>)>

Query the filesystem for filesystem-specific information.

source

pub fn close(&self) -> QueryResponseFut<CloseableCloseResult>

Terminates the connection.

After calling Close, the client must not send any other requests.

Servers, after sending the status response, should close the connection regardless of status and without sending an epitaph.

Closing the client end of the channel should be semantically equivalent to calling Close without knowing when the close has completed or its status.

source

pub fn query(&self) -> QueryResponseFut<Vec<u8>>

source

pub fn reopen( &self, rights_request: &RightsRequest, object_request: ServerEnd<NodeMarker> ) -> Result<(), Error>

Creates another connection to the same node.

source

pub fn get_connection_info(&self) -> QueryResponseFut<ConnectionInfo>

Acquires information about the connection.

This method does not require any rights.

source

pub fn get_attributes( &self, query: NodeAttributesQuery ) -> QueryResponseFut<Node2GetAttributesResult>

Acquires information about the node.

The attributes of a node should be stable, independent of the specific protocol used to access it.

If a particular attribute is not applicable or not supported, filesystems should leave the corresponding field absent.

  • query a bit-mask specifying which attributes to fetch. The server should not return more than necessary.
  • attributes the returned attributes.

This method requires the [Rights.GET_ATTRIBUTES] right.

source

pub fn update_attributes( &self, payload: &MutableNodeAttributes ) -> QueryResponseFut<Node2UpdateAttributesResult>

Updates information about the node.

  • attributes the presence of a table field in attributes indicates the intent to update the corresponding attribute.

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

source

pub fn sync(&self) -> QueryResponseFut<Node2SyncResult>

Synchronizes updates to the node to the underlying media, if it exists.

This method will return when the filesystem server has flushed the relevant updates to the underlying media, but does not guarantee the underlying media has persisted the information, nor that any information is committed to hardware. Clients may use Sync to ensure ordering between operations.

This method does not require any rights.

source

pub fn list_extended_attributes( &self, iterator: ServerEnd<ExtendedAttributeIteratorMarker> ) -> Result<(), Error>

Creates an iterator over all the extended attribute names associated with this node. If an error occurs it is returned as an epitaph on the iterator request channel, and then the channel is closed.

GetExtendedAttributes can be used with any of these names to retrieve the associated value.

This method requires the [Rights.GET_ATTRIBUTES] right.

source

pub fn get_extended_attribute( &self, name: &[u8] ) -> QueryResponseFut<Node2GetExtendedAttributeResult>

Get the value associated with the given attribute name for this node.

Attribute names have a maximum length of MAX_ATTRIBUTE_NAME. No particular structure is imposed on them.

This method requires the [Rights.GET_ATTRIBUTES] right.

source

pub fn set_extended_attribute( &self, name: &[u8], value: ExtendedAttributeValue, mode: SetExtendedAttributeMode ) -> QueryResponseFut<Node2SetExtendedAttributeResult>

Set the value for the given attribute name to value for this node.

The attribute name may exist, in which case the attribute is updated. If the attribute doesn’t exist, it is created. The name should have no null bytes in it. If it does, ZX_ERR_INVALID_ARGS is returned.

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

source

pub fn remove_extended_attribute( &self, name: &[u8] ) -> QueryResponseFut<Node2RemoveExtendedAttributeResult>

Remove the specified extended attribute.

If the attribute doesn’t exist, ZX_ERR_NOT_FOUND is returned.

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

source

pub fn connect_to_device_fidl(&self, server: Channel) -> Result<(), Error>

Connect to the underlying device’s FIDL protocol. This connection will not be multiplexed with fuchsia.device.Controller or fuchsia.io.Node.

source

pub fn connect_to_controller( &self, server: ServerEnd<ControllerMarker> ) -> Result<(), Error>

Connect to the same Controller FIDL protocol.

source

pub fn bind(&self, driver: &str) -> QueryResponseFut<ControllerBindResult>

Attempt to bind a driver to this device.

  • request driver This represents the suffix of a driver URL (e.g: “fvm.cm”). If this is non-empty, then the only drivers that will try to bind are ones that match this url suffix.
source

pub fn rebind(&self, driver: &str) -> QueryResponseFut<ControllerRebindResult>

Unbind all the children of this device, and then attempt to bind a driver to the device. This will not return until the bind completes.

  • request driver This represents the suffix of a driver URL (e.g: “fvm.cm”). If this is non-empty, then the only drivers that will try to bind are ones that match this url suffix.
source

pub fn unbind_children( &self ) -> QueryResponseFut<ControllerUnbindChildrenResult>

This api will unbind all the children of this device synchronously. This will avoid watching for device removal by the clients.

source

pub fn schedule_unbind( &self ) -> QueryResponseFut<ControllerScheduleUnbindResult>

Disconnect this device and allow its parent to be bound again. This may not complete before it returns.

source

pub fn get_topological_path( &self ) -> QueryResponseFut<ControllerGetTopologicalPathResult>

Return the topological path for this device

Trait Implementations§

source§

impl Clone for VolumeAndNodeProxy

source§

fn clone(&self) -> VolumeAndNodeProxy

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 VolumeAndNodeProxy

source§

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

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

impl Proxy for VolumeAndNodeProxy

§

type Protocol = VolumeAndNodeMarker

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.
source§

impl VolumeAndNodeProxyInterface for VolumeAndNodeProxy

§

type GetInfoResponseFut = QueryResponseFut<Result<BlockInfo, i32>>

source§

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

§

type GetStatsResponseFut = QueryResponseFut<Result<BlockStats, i32>>

source§

fn get_stats(&self, clear: bool) -> Self::GetStatsResponseFut

source§

fn open_session(&self, session: ServerEnd<SessionMarker>) -> Result<(), Error>

§

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

source§

fn read_blocks( &self, vmo: Vmo, length: u64, dev_offset: u64, vmo_offset: u64 ) -> Self::ReadBlocksResponseFut

§

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

source§

fn write_blocks( &self, vmo: Vmo, length: u64, dev_offset: u64, vmo_offset: u64 ) -> Self::WriteBlocksResponseFut

§

type GetTypeGuidResponseFut = QueryResponseFut<(i32, Option<Box<Guid>>)>

source§

fn get_type_guid(&self) -> Self::GetTypeGuidResponseFut

§

type GetInstanceGuidResponseFut = QueryResponseFut<(i32, Option<Box<Guid>>)>

source§

fn get_instance_guid(&self) -> Self::GetInstanceGuidResponseFut

§

type GetNameResponseFut = QueryResponseFut<(i32, Option<String>)>

source§

fn get_name(&self) -> Self::GetNameResponseFut

§

type QuerySlicesResponseFut = QueryResponseFut<(i32, [VsliceRange; 16], u64)>

source§

fn query_slices(&self, start_slices: &[u64]) -> Self::QuerySlicesResponseFut

§

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

source§

fn get_volume_info(&self) -> Self::GetVolumeInfoResponseFut

§

type ExtendResponseFut = QueryResponseFut<i32>

source§

fn extend(&self, start_slice: u64, slice_count: u64) -> Self::ExtendResponseFut

§

type ShrinkResponseFut = QueryResponseFut<i32>

source§

fn shrink(&self, start_slice: u64, slice_count: u64) -> Self::ShrinkResponseFut

§

type DestroyResponseFut = QueryResponseFut<i32>

source§

fn destroy(&self) -> Self::DestroyResponseFut

source§

fn clone( &self, flags: OpenFlags, object: ServerEnd<NodeMarker> ) -> Result<(), Error>

§

type GetAttrResponseFut = QueryResponseFut<(i32, NodeAttributes)>

source§

fn get_attr(&self) -> Self::GetAttrResponseFut

§

type SetAttrResponseFut = QueryResponseFut<i32>

source§

fn set_attr( &self, flags: NodeAttributeFlags, attributes: &NodeAttributes ) -> Self::SetAttrResponseFut

§

type GetFlagsResponseFut = QueryResponseFut<(i32, OpenFlags)>

source§

fn get_flags(&self) -> Self::GetFlagsResponseFut

§

type SetFlagsResponseFut = QueryResponseFut<i32>

source§

fn set_flags(&self, flags: OpenFlags) -> Self::SetFlagsResponseFut

§

type QueryFilesystemResponseFut = QueryResponseFut<(i32, Option<Box<FilesystemInfo>>)>

source§

fn query_filesystem(&self) -> Self::QueryFilesystemResponseFut

§

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

source§

fn close(&self) -> Self::CloseResponseFut

§

type QueryResponseFut = QueryResponseFut<Vec<u8>>

source§

fn query(&self) -> Self::QueryResponseFut

source§

fn reopen( &self, rights_request: &RightsRequest, object_request: ServerEnd<NodeMarker> ) -> Result<(), Error>

§

type GetConnectionInfoResponseFut = QueryResponseFut<ConnectionInfo>

source§

fn get_connection_info(&self) -> Self::GetConnectionInfoResponseFut

§

type GetAttributesResponseFut = QueryResponseFut<Result<(MutableNodeAttributes, ImmutableNodeAttributes), i32>>

source§

fn get_attributes( &self, query: NodeAttributesQuery ) -> Self::GetAttributesResponseFut

§

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

source§

fn update_attributes( &self, payload: &MutableNodeAttributes ) -> Self::UpdateAttributesResponseFut

§

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

source§

fn sync(&self) -> Self::SyncResponseFut

source§

fn list_extended_attributes( &self, iterator: ServerEnd<ExtendedAttributeIteratorMarker> ) -> Result<(), Error>

§

type GetExtendedAttributeResponseFut = QueryResponseFut<Result<ExtendedAttributeValue, i32>>

source§

fn get_extended_attribute( &self, name: &[u8] ) -> Self::GetExtendedAttributeResponseFut

§

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

source§

fn set_extended_attribute( &self, name: &[u8], value: ExtendedAttributeValue, mode: SetExtendedAttributeMode ) -> Self::SetExtendedAttributeResponseFut

§

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

source§

fn remove_extended_attribute( &self, name: &[u8] ) -> Self::RemoveExtendedAttributeResponseFut

source§

fn connect_to_device_fidl(&self, server: Channel) -> Result<(), Error>

source§

fn connect_to_controller( &self, server: ServerEnd<ControllerMarker> ) -> Result<(), Error>

§

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

source§

fn bind(&self, driver: &str) -> Self::BindResponseFut

§

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

source§

fn rebind(&self, driver: &str) -> Self::RebindResponseFut

§

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

source§

fn unbind_children(&self) -> Self::UnbindChildrenResponseFut

§

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

source§

fn schedule_unbind(&self) -> Self::ScheduleUnbindResponseFut

§

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

source§

fn get_topological_path(&self) -> Self::GetTopologicalPathResponseFut

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