Enum fidl_fuchsia_io::Directory1Request

pub enum Directory1Request {
    Clone {
        flags: OpenFlags,
        object: ServerEnd<NodeMarker>,
        control_handle: Directory1ControlHandle,
    },
    GetAttr {
        responder: Directory1GetAttrResponder,
    },
    SetAttr {
        flags: NodeAttributeFlags,
        attributes: NodeAttributes,
        responder: Directory1SetAttrResponder,
    },
    GetFlags {
        responder: Directory1GetFlagsResponder,
    },
    SetFlags {
        flags: OpenFlags,
        responder: Directory1SetFlagsResponder,
    },
    QueryFilesystem {
        responder: Directory1QueryFilesystemResponder,
    },
    Open {
        flags: OpenFlags,
        mode: ModeType,
        path: String,
        object: ServerEnd<NodeMarker>,
        control_handle: Directory1ControlHandle,
    },
    ReadDirents {
        max_bytes: u64,
        responder: Directory1ReadDirentsResponder,
    },
    Rewind {
        responder: Directory1RewindResponder,
    },
    GetToken {
        responder: Directory1GetTokenResponder,
    },
    Link {
        src: String,
        dst_parent_token: Handle,
        dst: String,
        responder: Directory1LinkResponder,
    },
    Watch {
        mask: WatchMask,
        options: u32,
        watcher: ServerEnd<DirectoryWatcherMarker>,
        responder: Directory1WatchResponder,
    },
}

Directory defines a node which is capable of containing other Objects.

Variants

Clone

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.

Fields

flags: OpenFlags

object: ServerEnd<NodeMarker>

control_handle: Directory1ControlHandle

GetAttr

Acquires information about the node.

This method does not require any rights.

Fields

responder: Directory1GetAttrResponder

SetAttr

Updates information about the node.

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

Fields

flags: NodeAttributeFlags

attributes: NodeAttributes

responder: Directory1SetAttrResponder

GetFlags

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

This method does not require any rights.

Fields

responder: Directory1GetFlagsResponder

SetFlags

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.

Fields

flags: OpenFlags

responder: Directory1SetFlagsResponder

QueryFilesystem

Query the filesystem for filesystem-specific information.

Fields

responder: Directory1QueryFilesystemResponder

Open

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.

Fields

flags: OpenFlags

mode: ModeType

path: String

object: ServerEnd<NodeMarker>

control_handle: Directory1ControlHandle

ReadDirents

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.

Fields

max_bytes: u64

responder: Directory1ReadDirentsResponder

Rewind

Resets the directory seek offset.

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

Fields

responder: Directory1RewindResponder

GetToken

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.

Fields

responder: Directory1GetTokenResponder

Link

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.

Fields

src: String

dst_parent_token: Handle

dst: String

responder: Directory1LinkResponder

Watch

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.

Fields

mask: WatchMask

options: u32

watcher: ServerEnd<DirectoryWatcherMarker>

responder: Directory1WatchResponder

Implementations

impl Directory1Request

pub fn into_clone( self ) -> Option<(OpenFlags, ServerEnd<NodeMarker>, Directory1ControlHandle)>

pub fn into_get_attr(self) -> Option<Directory1GetAttrResponder>

pub fn into_set_attr( self ) -> Option<(NodeAttributeFlags, NodeAttributes, Directory1SetAttrResponder)>

pub fn into_get_flags(self) -> Option<Directory1GetFlagsResponder>

pub fn into_set_flags(self) -> Option<(OpenFlags, Directory1SetFlagsResponder)>

pub fn into_query_filesystem(self) -> Option<Directory1QueryFilesystemResponder>

pub fn into_open( self ) -> Option<(OpenFlags, ModeType, String, ServerEnd<NodeMarker>, Directory1ControlHandle)>

pub fn into_read_dirents(self) -> Option<(u64, Directory1ReadDirentsResponder)>

pub fn into_rewind(self) -> Option<Directory1RewindResponder>

pub fn into_get_token(self) -> Option<Directory1GetTokenResponder>

pub fn into_link( self ) -> Option<(String, Handle, String, Directory1LinkResponder)>

pub fn into_watch( self ) -> Option<(WatchMask, u32, ServerEnd<DirectoryWatcherMarker>, Directory1WatchResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for Directory1Request

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

Formats the value using the given formatter.