pub enum Directory2Request {
Show 17 variants
Close {
responder: Directory2CloseResponder,
},
Query {
responder: Directory2QueryResponder,
},
Reopen {
rights_request: RightsRequest,
object_request: ServerEnd<NodeMarker>,
control_handle: Directory2ControlHandle,
},
GetConnectionInfo {
responder: Directory2GetConnectionInfoResponder,
},
GetAttributes {
query: NodeAttributesQuery,
responder: Directory2GetAttributesResponder,
},
UpdateAttributes {
payload: MutableNodeAttributes,
responder: Directory2UpdateAttributesResponder,
},
Sync {
responder: Directory2SyncResponder,
},
ListExtendedAttributes {
iterator: ServerEnd<ExtendedAttributeIteratorMarker>,
control_handle: Directory2ControlHandle,
},
GetExtendedAttribute {
name: Vec<u8>,
responder: Directory2GetExtendedAttributeResponder,
},
SetExtendedAttribute {
name: Vec<u8>,
value: ExtendedAttributeValue,
mode: SetExtendedAttributeMode,
responder: Directory2SetExtendedAttributeResponder,
},
RemoveExtendedAttribute {
name: Vec<u8>,
responder: Directory2RemoveExtendedAttributeResponder,
},
AdvisoryLock {
request: AdvisoryLockRequest,
responder: Directory2AdvisoryLockResponder,
},
Open2 {
path: String,
protocols: ConnectionProtocols,
object_request: Channel,
control_handle: Directory2ControlHandle,
},
Unlink {
name: String,
options: UnlinkOptions,
responder: Directory2UnlinkResponder,
},
Enumerate {
options: DirectoryEnumerateOptions,
iterator: ServerEnd<DirectoryIteratorMarker>,
control_handle: Directory2ControlHandle,
},
Rename {
src: String,
dst_parent_token: Event,
dst: String,
responder: Directory2RenameResponder,
},
CreateSymlink {
name: String,
target: Vec<u8>,
connection: Option<ServerEnd<SymlinkMarker>>,
responder: Directory2CreateSymlinkResponder,
},
}
Expand description
A [Node2
] that is capable of containing other nodes.
Variants§
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: Directory2CloseResponder
Query
Fields
responder: Directory2QueryResponder
Reopen
Creates another connection to the same node.
Fields
rights_request: RightsRequest
object_request: ServerEnd<NodeMarker>
control_handle: Directory2ControlHandle
GetConnectionInfo
Acquires information about the connection.
This method does not require any rights.
Fields
responder: Directory2GetConnectionInfoResponder
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 inattributes
indicates the intent to update the corresponding attribute.
This method requires the [Rights.UPDATE_ATTRIBUTES
] right.
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: Directory2SyncResponder
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.
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
] ifrequest.type
is [AdvisoryLockType.READ
]. - [
Rights.WRITE_BYTES
] ifrequest.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
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
ifpath
is invalid.
Fields
protocols: ConnectionProtocols
object_request: Channel
control_handle: Directory2ControlHandle
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
ifname
is invalid. - error
ZX_ERR_NOT_EMPTY
ifname
refers to a non-empty directory. - error
ZX_ERR_UNAVAILABLE
ifname
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
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.
Fields
options: DirectoryEnumerateOptions
iterator: ServerEnd<DirectoryIteratorMarker>
control_handle: Directory2ControlHandle
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
ifsrc
ordst
is invalid. - error
ZX_ERR_ACCESS_DENIED
for insufficient rights.
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
ifname
already exists. -
error
ZX_ERR_BAD_PATH
iftarget
exceeds the server length limit for symbolic links. -
error
ZX_ERR_INVALID_ARGS
ifname
is not a validName
. -
error
ZX_ERR_NOT_SUPPORTED
if creating symbolic links is not supported by the server.
Implementations§
source§impl Directory2Request
impl Directory2Request
pub fn into_close(self) -> Option<Directory2CloseResponder>
pub fn into_query(self) -> Option<Directory2QueryResponder>
pub fn into_reopen( self ) -> Option<(RightsRequest, ServerEnd<NodeMarker>, Directory2ControlHandle)>
pub fn into_get_connection_info( self ) -> Option<Directory2GetConnectionInfoResponder>
pub fn into_get_attributes( self ) -> Option<(NodeAttributesQuery, Directory2GetAttributesResponder)>
pub fn into_update_attributes( self ) -> Option<(MutableNodeAttributes, Directory2UpdateAttributesResponder)>
pub fn into_sync(self) -> Option<Directory2SyncResponder>
pub fn into_list_extended_attributes( self ) -> Option<(ServerEnd<ExtendedAttributeIteratorMarker>, Directory2ControlHandle)>
pub fn into_get_extended_attribute( self ) -> Option<(Vec<u8>, Directory2GetExtendedAttributeResponder)>
pub fn into_set_extended_attribute( self ) -> Option<(Vec<u8>, ExtendedAttributeValue, SetExtendedAttributeMode, Directory2SetExtendedAttributeResponder)>
pub fn into_remove_extended_attribute( self ) -> Option<(Vec<u8>, Directory2RemoveExtendedAttributeResponder)>
pub fn into_advisory_lock( self ) -> Option<(AdvisoryLockRequest, Directory2AdvisoryLockResponder)>
pub fn into_open2( self ) -> Option<(String, ConnectionProtocols, Channel, Directory2ControlHandle)>
pub fn into_unlink( self ) -> Option<(String, UnlinkOptions, Directory2UnlinkResponder)>
pub fn into_enumerate( self ) -> Option<(DirectoryEnumerateOptions, ServerEnd<DirectoryIteratorMarker>, Directory2ControlHandle)>
pub fn into_rename( self ) -> Option<(String, Event, String, Directory2RenameResponder)>
pub fn into_create_symlink( self ) -> Option<(String, Vec<u8>, Option<ServerEnd<SymlinkMarker>>, Directory2CreateSymlinkResponder)>
sourcepub fn method_name(&self) -> &'static str
pub fn method_name(&self) -> &'static str
Name of the method defined in FIDL