pub enum DirectoryRequest {
Show 29 variants 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, }, Open { flags: OpenFlags, mode: ModeType, path: String, object: ServerEnd<NodeMarker>, 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, }, Watch { mask: WatchMask, options: u32, watcher: ServerEnd<DirectoryWatcherMarker>, responder: DirectoryWatchResponder, }, Close { responder: DirectoryCloseResponder, }, Query { responder: DirectoryQueryResponder, }, Reopen { rights_request: RightsRequest, object_request: ServerEnd<NodeMarker>, control_handle: DirectoryControlHandle, }, 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, }, AdvisoryLock { request: AdvisoryLockRequest, responder: DirectoryAdvisoryLockResponder, }, Open2 { path: String, protocols: ConnectionProtocols, object_request: Channel, control_handle: DirectoryControlHandle, }, Unlink { name: String, options: UnlinkOptions, responder: DirectoryUnlinkResponder, }, Enumerate { options: DirectoryEnumerateOptions, iterator: ServerEnd<DirectoryIteratorMarker>, control_handle: DirectoryControlHandle, }, Rename { src: String, dst_parent_token: Event, dst: String, responder: DirectoryRenameResponder, }, CreateSymlink { name: String, target: Vec<u8>, connection: Option<ServerEnd<SymlinkMarker>>, responder: DirectoryCreateSymlinkResponder, },
}

Variants§

§

Clone

Fields

§object: ServerEnd<NodeMarker>
§control_handle: DirectoryControlHandle

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.

§

GetAttr

Acquires information about the node.

This method does not require any rights.

§

SetAttr

Updates information about the node.

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

§

GetFlags

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

This method does not require any rights.

§

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.

§

QueryFilesystem

Query the filesystem for filesystem-specific information.

§

Open

Fields

§path: String
§object: ServerEnd<NodeMarker>
§control_handle: DirectoryControlHandle

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.

§

ReadDirents

Fields

§max_bytes: u64

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.

§

Rewind

Resets the directory seek offset.

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

§

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

§dst_parent_token: Handle

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.

§

Watch

Fields

§options: u32
§watcher: ServerEnd<DirectoryWatcherMarker>

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.

§

Close

Fields

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.

§

Query

Fields

§

Reopen

Fields

§rights_request: RightsRequest
§object_request: ServerEnd<NodeMarker>
§control_handle: DirectoryControlHandle

Creates another connection to the same node.

§

GetConnectionInfo

Acquires information about the connection.

This method does not require any rights.

§

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.

§

UpdateAttributes

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.

§

Sync

Fields

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.

§

ListExtendedAttributes

Fields

§control_handle: DirectoryControlHandle

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.

§

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.

§

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.

§

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.

§

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

Open2

Fields

§path: String
§object_request: Channel
§control_handle: DirectoryControlHandle

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.

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]
§

Enumerate

Fields

§iterator: ServerEnd<DirectoryIteratorMarker>
§control_handle: DirectoryControlHandle

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.

§

Rename

Fields

§dst_parent_token: Event

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

§name: String
§target: Vec<u8>
§connection: Option<ServerEnd<SymlinkMarker>>

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.

Implementations§

source§

impl DirectoryRequest

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

pub fn into_reopen( self ) -> Option<(RightsRequest, ServerEnd<NodeMarker>, DirectoryControlHandle)>

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

pub fn into_enumerate( self ) -> Option<(DirectoryEnumerateOptions, ServerEnd<DirectoryIteratorMarker>, DirectoryControlHandle)>

source

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

source

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

Name of the method defined in FIDL

Trait Implementations§

source§

impl Debug for DirectoryRequest

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more