Struct fidl_fuchsia_io::Directory1Proxy

source ·

pub struct Directory1Proxy { /* private fields */ }

Implementations§

source §

impl Directory1Proxy

source

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.io/Directory1.

source

pub fn take_event_stream(&self) -> Directory1EventStream

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

§Panics

Panics if the event stream was already taken.

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

source

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.

source

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

Resets the directory seek offset.

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

source

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.

source

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 and OpenFlags.RIGHT_READABLE, otherwise returns ZX_ERR_BAD_HANDLE.

This will be atomic with respect to renaming or unlinking the source concurrently e.g. if there are two actors operating concurrently, and one actor performs a rename that affects the source within this directory, and the other does a link, each will appear to occur atomically in an unspecified order.

source