Enum fidl_fuchsia_io::DirectoryRequest

pub enum DirectoryRequest {
    AdvisoryLock {
        request: AdvisoryLockRequest,
        responder: DirectoryAdvisoryLockResponder,
    },
    Clone2 {
        request: ServerEnd<CloneableMarker>,
        control_handle: DirectoryControlHandle,
    },
    Close {
        responder: DirectoryCloseResponder,
    },
    Query {
        responder: DirectoryQueryResponder,
    },
    Clone {
        flags: OpenFlags,
        object: ServerEnd<NodeMarker>,
        control_handle: DirectoryControlHandle,
    },
    GetAttr {
        responder: DirectoryGetAttrResponder,
    },
    SetAttr {
        flags: NodeAttributeFlags,
        attributes: NodeAttributes,
        responder: DirectorySetAttrResponder,
    },
    GetFlags {
        responder: DirectoryGetFlagsResponder,
    },
    SetFlags {
        flags: OpenFlags,
        responder: DirectorySetFlagsResponder,
    },
    QueryFilesystem {
        responder: DirectoryQueryFilesystemResponder,
    },
    GetConnectionInfo {
        responder: DirectoryGetConnectionInfoResponder,
    },
    GetAttributes {
        query: NodeAttributesQuery,
        responder: DirectoryGetAttributesResponder,
    },
    UpdateAttributes {
        payload: MutableNodeAttributes,
        responder: DirectoryUpdateAttributesResponder,
    },
    Sync {
        responder: DirectorySyncResponder,
    },
    ListExtendedAttributes {
        iterator: ServerEnd<ExtendedAttributeIteratorMarker>,
        control_handle: DirectoryControlHandle,
    },
    GetExtendedAttribute {
        name: Vec<u8>,
        responder: DirectoryGetExtendedAttributeResponder,
    },
    SetExtendedAttribute {
        name: Vec<u8>,
        value: ExtendedAttributeValue,
        mode: SetExtendedAttributeMode,
        responder: DirectorySetExtendedAttributeResponder,
    },
    RemoveExtendedAttribute {
        name: Vec<u8>,
        responder: DirectoryRemoveExtendedAttributeResponder,
    },
    Open {
        flags: OpenFlags,
        mode: ModeType,
        path: String,
        object: ServerEnd<NodeMarker>,
        control_handle: DirectoryControlHandle,
    },
    Open2 {
        path: String,
        protocols: ConnectionProtocols,
        object_request: Channel,
        control_handle: DirectoryControlHandle,
    },
    Open3 {
        path: String,
        flags: Flags,
        options: Options,
        object: Channel,
        control_handle: DirectoryControlHandle,
    },
    ReadDirents {
        max_bytes: u64,
        responder: DirectoryReadDirentsResponder,
    },
    Rewind {
        responder: DirectoryRewindResponder,
    },
    GetToken {
        responder: DirectoryGetTokenResponder,
    },
    Link {
        src: String,
        dst_parent_token: Handle,
        dst: String,
        responder: DirectoryLinkResponder,
    },
    Unlink {
        name: String,
        options: UnlinkOptions,
        responder: DirectoryUnlinkResponder,
    },
    Rename {
        src: String,
        dst_parent_token: Event,
        dst: String,
        responder: DirectoryRenameResponder,
    },
    CreateSymlink {
        name: String,
        target: Vec<u8>,
        connection: Option<ServerEnd<SymlinkMarker>>,
        responder: DirectoryCreateSymlinkResponder,
    },
    Watch {
        mask: WatchMask,
        options: u32,
        watcher: ServerEnd<DirectoryWatcherMarker>,
        responder: DirectoryWatchResponder,
    },
    _UnknownMethod {
        ordinal: u64,
        control_handle: DirectoryControlHandle,
        method_type: MethodType,
    },
}

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

Variants

AdvisoryLock

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.

Fields

request: AdvisoryLockRequest

responder: DirectoryAdvisoryLockResponder

Clone2

Fields

request: ServerEnd<CloneableMarker>

control_handle: DirectoryControlHandle

Close

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.

Fields

responder: DirectoryCloseResponder

Query

Fields

responder: DirectoryQueryResponder

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: DirectoryControlHandle

GetAttr

Acquires information about the node.

This method does not require any rights.

Fields

responder: DirectoryGetAttrResponder

SetAttr

Updates information about the node.

Returns ZX_ERR_NOT_SUPPORTED if any attributes specified by [flags] are not supported.

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

Fields

flags: NodeAttributeFlags

attributes: NodeAttributes

responder: DirectorySetAttrResponder

GetFlags

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

This method does not require any rights.

Fields

responder: DirectoryGetFlagsResponder

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: DirectorySetFlagsResponder

QueryFilesystem

Query the filesystem for filesystem-specific information.

Fields

responder: DirectoryQueryFilesystemResponder

GetConnectionInfo

Acquires information about the connection.

This method does not require any rights.

Fields

responder: DirectoryGetConnectionInfoResponder

GetAttributes

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.

Fields

query: NodeAttributesQuery

responder: DirectoryGetAttributesResponder

UpdateAttributes

Updates information about the node.

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

Returns ZX_ERR_NOT_SUPPORTED if the node does not support any of the specified attributes.

This method requires the [Rights.UPDATE_ATTRIBUTES] right.

Fields

payload: MutableNodeAttributes

responder: DirectoryUpdateAttributesResponder

Sync

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.

Fields

responder: DirectorySyncResponder

ListExtendedAttributes

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.

Fields

iterator: ServerEnd<ExtendedAttributeIteratorMarker>

control_handle: DirectoryControlHandle

GetExtendedAttribute

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.

Fields

name: Vec<u8>

responder: DirectoryGetExtendedAttributeResponder

SetExtendedAttribute

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.

Fields

name: Vec<u8>

value: ExtendedAttributeValue

mode: SetExtendedAttributeMode

responder: DirectorySetExtendedAttributeResponder

RemoveExtendedAttribute

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.

Fields

name: Vec<u8>

responder: DirectoryRemoveExtendedAttributeResponder

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: DirectoryControlHandle

Open2

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.

Fields

path: String

protocols: ConnectionProtocols

object_request: Channel

control_handle: DirectoryControlHandle

Open3

Open (or create) a node relative to this directory. Any errors are communicated via an epitaph sent on the object channel.

Errors:

• ZX_ERR_BAD_PATH if path is invalid
• See Flags for other errors which may be communicated based on flags

Fields

path: String

flags: Flags

options: Options

object: Channel

control_handle: DirectoryControlHandle

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: DirectoryReadDirentsResponder

Rewind

Resets the directory seek offset.

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

Fields

responder: DirectoryRewindResponder

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: DirectoryGetTokenResponder

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: DirectoryLinkResponder

Unlink

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]

Fields

name: String

options: UnlinkOptions

responder: DirectoryUnlinkResponder

Rename

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]

The following requirements are necessary to avoid rights escalations.

If the source and destination directory differ, the source directory must also have the maximal set of abilities supported for files, which would typically be [Rights.READ_BYTES], [Rights.WRITE_BYTES], [Rights.GET_ATTRIBUTES] and [Rights.UPDATE_ATTRIBUTES]. Some filesystems might also support the [Rights.EXECUTE] right.

If src refers to a directory, and differs from the destination directory, then the source directory must have also have the [Rights.CONNECT] and [Rights.TRAVERSE] rights.

• error ZX_ERR_INVALID_ARGS if src or dst is invalid.
• error ZX_ERR_ACCESS_DENIED for insufficient rights.

Fields

src: String

dst_parent_token: Event

dst: String

responder: DirectoryRenameResponder

CreateSymlink

Creates a symbolic link.

name is the name to be given to the created symbolic link. target is the target of the symbolic link, which has no meaning on the server. The server will perform no validation of target except for a server chosen maximum length. connection is an optional server end of a channel that will speak the Symlink protocol on the successfully created node.

• [Rights.MODIFY_DIRECTORY]

• error ZX_ERR_ALREADY_EXISTS if name already exists.

• error ZX_ERR_BAD_PATH if target exceeds the server length limit for symbolic links.

• error ZX_ERR_INVALID_ARGS if name is not a valid Name.

• error ZX_ERR_NOT_SUPPORTED if creating symbolic links is not supported by the server.

Fields

name: String

target: Vec<u8>

connection: Option<ServerEnd<SymlinkMarker>>

responder: DirectoryCreateSymlinkResponder

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: DirectoryWatchResponder

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: DirectoryControlHandle

method_type: MethodType

Implementations

impl DirectoryRequest

pub fn into_advisory_lock( self, ) -> Option<(AdvisoryLockRequest, DirectoryAdvisoryLockResponder)>

pub fn into_clone2( self, ) -> Option<(ServerEnd<CloneableMarker>, DirectoryControlHandle)>

pub fn into_close(self) -> Option<DirectoryCloseResponder>

pub fn into_query(self) -> Option<DirectoryQueryResponder>

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

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

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

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

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

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

pub fn into_get_connection_info( self, ) -> Option<DirectoryGetConnectionInfoResponder>

pub fn into_get_attributes( self, ) -> Option<(NodeAttributesQuery, DirectoryGetAttributesResponder)>

pub fn into_update_attributes( self, ) -> Option<(MutableNodeAttributes, DirectoryUpdateAttributesResponder)>

pub fn into_sync(self) -> Option<DirectorySyncResponder>

pub fn into_list_extended_attributes( self, ) -> Option<(ServerEnd<ExtendedAttributeIteratorMarker>, DirectoryControlHandle)>

pub fn into_get_extended_attribute( self, ) -> Option<(Vec<u8>, DirectoryGetExtendedAttributeResponder)>

pub fn into_set_extended_attribute( self, ) -> Option<(Vec<u8>, ExtendedAttributeValue, SetExtendedAttributeMode, DirectorySetExtendedAttributeResponder)>

pub fn into_remove_extended_attribute( self, ) -> Option<(Vec<u8>, DirectoryRemoveExtendedAttributeResponder)>

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

pub fn into_open2( self, ) -> Option<(String, ConnectionProtocols, Channel, DirectoryControlHandle)>

pub fn into_open3( self, ) -> Option<(String, Flags, Options, Channel, DirectoryControlHandle)>

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

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

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

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

pub fn into_unlink( self, ) -> Option<(String, UnlinkOptions, DirectoryUnlinkResponder)>

pub fn into_rename( self, ) -> Option<(String, Event, String, DirectoryRenameResponder)>

pub fn into_create_symlink( self, ) -> Option<(String, Vec<u8>, Option<ServerEnd<SymlinkMarker>>, DirectoryCreateSymlinkResponder)>

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

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

Name of the method defined in FIDL

Trait Implementations

impl Debug for DirectoryRequest

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

Formats the value using the given formatter.