Struct fidl_fuchsia_io::Directory1Proxy

pub struct Directory1Proxy { /* private fields */ }

Implementations

impl Directory1Proxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for Directory1

pub fn take_event_stream(&self) -> Directory1EventStream

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

Panics

Panics if the event stream was already taken.

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.

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

Acquires information about the node.

This method does not require any rights.

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

Updates information about the node.

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

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.

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.

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

Query the filesystem for filesystem-specific information.

pub fn open( &self, flags: OpenFlags, mode: ModeType, path: &str, object: ServerEnd<NodeMarker> ) -> Result<(), Error>

Opens a new object relative to this directory object.

path may contain multiple segments, separated by “/” characters, and should never be empty; i.e. “” is an invalid path. A trailing slash implies OpenFlags.DIRECTORY. Components must not be empty (i.e. “foo//bar” is invalid). “..” is disallowed anywhere in the path. “.” is only allowed if the path is exactly “.”, but not otherwise. A leading ‘/’ is allowed (and is treated the same way as if not present, i.e. “/foo/bar’ and “foo/bar” are the same).

If an unknown value is sent for flags the connection should be closed.

OpenFlags.RIGHT_* flags provided in flags will restrict access rights on the object channel which will be connected to the opened entity.

Rights are never increased. When you open a nested entity within a directory, you may only request the same rights as what the directory connection already has, or a subset of those. Exceeding those rights causes an access denied error to be transmitted in the OnOpen event if applicable, and the object connection closed.

mode is ignored.

pub fn read_dirents(&self, max_bytes: u64) -> QueryResponseFut<(i32, Vec<u8>)>

Reads a collection of variably sized dirents into a buffer. The number of dirents in a directory may be very large: akin to calling read multiple times on a file, directories have a seek offset which is updated on subsequent calls to ReadDirents. Each call to ReadDirents will only return whole dirent structures, they will not get split across ReadDirent calls. When the seek offset reaches the end, dirents will be empty.

These dirents are of the form:

struct dirent {
  // Describes the inode of the entry.
  uint64 ino;
  // Describes the length of the dirent name in bytes.
  uint8 size;
  // Describes the type of the entry. Aligned with the
  // POSIX d_type values. Use `DirentType` constants.
  uint8 type;
  // Unterminated name of entry.
  char name[0];
}

This method does not require any rights, since one could always probe for directory contents by triggering name conflicts during file creation.

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

Resets the directory seek offset.

This method does not require any rights, similar to ReadDirents.

pub fn get_token(&self) -> QueryResponseFut<(i32, Option<Handle>)>

Acquires a token to a Directory which can be used to identify access to it at a later point in time. The token will remain valid for as long as the connection requesting the token remains open.

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

pub fn link( &self, src: &str, dst_parent_token: Handle, dst: &str ) -> QueryResponseFut<i32>

Creates a link to an object named src by the name dst, within a directory represented by token.

src must be a resolved object name. Including “/” in the string will return ZX_ERR_INVALID_ARGS.

dst must be a resolved object name. Including “/” in the string will return ZX_ERR_INVALID_ARGS.

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

pub fn watch( &self, mask: WatchMask, options: u32, watcher: ServerEnd<DirectoryWatcherMarker> ) -> QueryResponseFut<i32>

Watches a directory, receiving events of added messages on the watcher request channel.

Options must be zero; it is reserved.

This method does not require any rights, similar to ReadDirents.

Trait Implementations

impl Clone for Directory1Proxy

fn clone(&self) -> Directory1Proxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Directory1Proxy

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

Formats the value using the given formatter.

impl Directory1ProxyInterface for Directory1Proxy

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

type GetAttrResponseFut = QueryResponseFut<(i32, NodeAttributes)>

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

type SetAttrResponseFut = QueryResponseFut<i32>

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

type GetFlagsResponseFut = QueryResponseFut<(i32, OpenFlags)>

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

type SetFlagsResponseFut = QueryResponseFut<i32>

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

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

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

fn open( &self, flags: OpenFlags, mode: ModeType, path: &str, object: ServerEnd<NodeMarker> ) -> Result<(), Error>

type ReadDirentsResponseFut = QueryResponseFut<(i32, Vec<u8, Global>)>

fn read_dirents(&self, max_bytes: u64) -> Self::ReadDirentsResponseFut

type RewindResponseFut = QueryResponseFut<i32>

fn rewind(&self) -> Self::RewindResponseFut

type GetTokenResponseFut = QueryResponseFut<(i32, Option<Handle>)>

fn get_token(&self) -> Self::GetTokenResponseFut

type LinkResponseFut = QueryResponseFut<i32>

fn link( &self, src: &str, dst_parent_token: Handle, dst: &str ) -> Self::LinkResponseFut

type WatchResponseFut = QueryResponseFut<i32>

fn watch( &self, mask: WatchMask, options: u32, watcher: ServerEnd<DirectoryWatcherMarker> ) -> Self::WatchResponseFut

impl Proxy for Directory1Proxy

type Protocol = Directory1Marker

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.