Struct fidl_fuchsia_io::Directory2Proxy

pub struct Directory2Proxy { /* private fields */ }

Implementations

impl Directory2Proxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for Directory2

pub fn take_event_stream(&self) -> Directory2EventStream

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

Panics

Panics if the event stream was already taken.

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.

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

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

Creates another connection to the same node.

• object_request is the server end of a channel created for the new connection. The caller may proceed to send messages on the corresponding client end right away.

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

Acquires information about the connection.

This method does not require any rights.

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.

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.

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.

pub fn advisory_lock( &self, request: AdvisoryLockRequest ) -> QueryResponseFut<AdvisoryLockingAdvisoryLockResult>

Acquires an advisory lock on the underlying file.

The lock lasts until either this connection is closed or this method is called with |AdvisoryLockType.UNLOCK| to release the lock explicitly.

Advisory locks are purely advisory. They do not prevent actual read or write operations from occurring on the file, either through this connection or through other connections.

This method requires the following rights:

• [Rights.READ_BYTES] if request.type is [AdvisoryLockType.READ].
• [Rights.WRITE_BYTES] if request.type is [AdvisoryLockType.WRITE].

Errors

• ZX_ERR_BAD_STATE The specified type of lock cannot be acquired. For example, another connection might hold a conflicting lock type.
• ZX_ERR_NOT_SUPPORTED This file does not support advisory locking.
• ZX_ERR_ACCESS_DENIED This connection does not have sufficient rights to acquire the given type of lock.

pub fn open2( &self, path: &str, protocols: &mut ConnectionProtocols, object_request: Channel ) -> Result<(), Error>

Opens or creates a new node relative to this directory node.

This method requires the following rights on the current connection:

• [Rights.ENUMERATE]
• [Rights.TRAVERSE]

Errors are presented as an epitaph on the object_request channel.

• error ZX_ERR_ACCESS_DENIED if the requested rights exceeds what is allowed.
• error ZX_ERR_BAD_PATH if path is invalid.

pub fn add_inotify_filter( &self, path: &str, filter: InotifyWatchMask, watch_descriptor: u32, socket: Socket ) -> QueryResponseFut<()>

Adds a new inotify filter for an object relative to this directory object.

• ’filter` is a mask of different inotify events that need to be watched by the server for a specific file/directory.

• path may contain multiple segments, separated by “/” characters, and should never be empty; i.e., “” is an invalid path. Paths should not contain a leading “/”.

+watch_descriptor is client assigned value to identify a filter. Server shouldn’t trust the client-assigned watch_descriptor. They should just send it back to the client in the socket. This value is not used by server, but it is returned back as part of InotifyEvent, to help the client correlate filter with events on this filter.

• socket is shared between different filter objects i.e every new filter will have a different server end of the socket and there will be a single client end per inotify instance on inotify init.

pub fn unlink( &self, name: &str, options: UnlinkOptions ) -> QueryResponseFut<Directory2UnlinkResult>

Removes a child node from the this directory’s list of entries.

Note: this does not guarantee that the underlying object is destroyed. Although the link will be removed from the containing directory, objects with multiple references (such as files which are still open) will not actually be destroyed until all references are closed.

• error ZX_ERR_ACCESS_DENIED if the connection does not have [Rights.WRITE_BYTES].
• error ZX_ERR_NOT_SUPPORTED if the underlying filesystem does not support writing.
• error ZX_ERR_BAD_PATH if name is invalid.
• error ZX_ERR_NOT_EMPTY if name refers to a non-empty directory.
• error ZX_ERR_UNAVAILABLE if name refers to a mount point, containing a remote channel.
• error ZX_ERR_NOT_DIR if the options requested a directory but something other than a directory was found.

Other errors may be returned for filesystem-specific reasons.

This method requires the following rights:

• [Rights.ENUMERATE]
• [Rights.MODIFY_DIRECTORY]

pub fn enumerate( &self, options: DirectoryEnumerateOptions, iterator: ServerEnd<DirectoryIteratorMarker> ) -> Result<(), Error>

Initiates a directory listing operation over the input channel, starting at seek offset 0.

This method requires the [Rights.ENUMERATE] right. If this right is absent, iterator will be closed with a ZX_ERR_ACCESS_DENIED epitaph.

pub fn rename( &self, src: &str, dst_parent_token: Event, dst: &str ) -> QueryResponseFut<Directory2RenameResult>

Renames a node named src to the name dst, in a directory represented by dst_parent_token.

src and dst must be valid node names. See [Name] for what constitutes a valid name.

This method requires the following rights on both the current connection, and the connection identified by dst_parent_token:

• [Rights.ENUMERATE]

• [Rights.MODIFY_DIRECTORY]

• error ZX_ERR_INVALID_ARGS if src or dst is invalid.

Trait Implementations

impl Clone for Directory2Proxy

fn clone(&self) -> Directory2Proxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Directory2Proxy

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

Formats the value using the given formatter.

impl Directory2ProxyInterface for Directory2Proxy

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

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

type QueryResponseFut = QueryResponseFut<Vec<u8, Global>>

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

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

type GetConnectionInfoResponseFut = QueryResponseFut<ConnectionInfo>

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

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

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

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

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

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

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

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

fn advisory_lock( &self, request: AdvisoryLockRequest ) -> Self::AdvisoryLockResponseFut

fn open2( &self, path: &str, protocols: &mut ConnectionProtocols, object_request: Channel ) -> Result<(), Error>

type AddInotifyFilterResponseFut = QueryResponseFut<()>

fn add_inotify_filter( &self, path: &str, filter: InotifyWatchMask, watch_descriptor: u32, socket: Socket ) -> Self::AddInotifyFilterResponseFut

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

fn unlink(&self, name: &str, options: UnlinkOptions) -> Self::UnlinkResponseFut

fn enumerate( &self, options: DirectoryEnumerateOptions, iterator: ServerEnd<DirectoryIteratorMarker> ) -> Result<(), Error>

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

fn rename( &self, src: &str, dst_parent_token: Event, dst: &str ) -> Self::RenameResponseFut

impl Proxy for Directory2Proxy

type Protocol = Directory2Marker

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 is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

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

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