Struct fidl_fuchsia_io::Directory2SynchronousProxy

source ·

pub struct Directory2SynchronousProxy { /* private fields */ }

Implementations§

source §

pub fn wait_for_event( &self, deadline: MonotonicTime, ) -> Result<Directory2Event, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

source

pub fn close( &self, ___deadline: MonotonicTime, ) -> Result<CloseableCloseResult, Error>

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.

source

pub fn query(&self, ___deadline: MonotonicTime) -> Result<Vec<u8>, Error>

source

pub fn reopen( &self, rights_request: &RightsRequest, object_request: ServerEnd<NodeMarker>, ) -> Result<(), Error>

Creates another connection to the same node.

source

pub fn get_connection_info( &self, ___deadline: MonotonicTime, ) -> Result<ConnectionInfo, Error>

Acquires information about the connection.

This method does not require any rights.

source

pub fn get_attributes( &self, query: NodeAttributesQuery, ___deadline: MonotonicTime, ) -> Result<Node2GetAttributesResult, Error>

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.

source

pub fn update_attributes( &self, payload: &MutableNodeAttributes, ___deadline: MonotonicTime, ) -> Result<Node2UpdateAttributesResult, Error>

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.

source

pub fn sync(&self, ___deadline: MonotonicTime) -> Result<Node2SyncResult, Error>

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.

source

pub fn list_extended_attributes( &self, iterator: ServerEnd<ExtendedAttributeIteratorMarker>, ) -> Result<(), Error>

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.

source

pub fn get_extended_attribute( &self, name: &[u8], ___deadline: MonotonicTime, ) -> Result<Node2GetExtendedAttributeResult, Error>

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.

source

pub fn set_extended_attribute( &self, name: &[u8], value: ExtendedAttributeValue, mode: SetExtendedAttributeMode, ___deadline: MonotonicTime, ) -> Result<Node2SetExtendedAttributeResult, Error>

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.

source

pub fn remove_extended_attribute( &self, name: &[u8], ___deadline: MonotonicTime, ) -> Result<Node2RemoveExtendedAttributeResult, Error>

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.

source

pub fn advisory_lock( &self, request: &AdvisoryLockRequest, ___deadline: MonotonicTime, ) -> Result<AdvisoryLockingAdvisoryLockResult, Error>

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.

source

pub fn open2( &self, path: &str, protocols: &ConnectionProtocols, object_request: Channel, ) -> Result<(), Error>

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.

source

pub fn open3( &self, path: &str, flags: Flags, options: &Options, object: Channel, ) -> Result<(), Error>

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

source

pub fn unlink( &self, name: &str, options: &UnlinkOptions, ___deadline: MonotonicTime, ) -> Result<Directory2UnlinkResult, Error>

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]

source

pub fn rename( &self, src: &str, dst_parent_token: Event, dst: &str, ___deadline: MonotonicTime, ) -> Result<Directory2RenameResult, Error>

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.

source

pub fn create_symlink( &self, name: &str, target: &[u8], connection: Option<ServerEnd<SymlinkMarker>>, ___deadline: MonotonicTime, ) -> Result<Directory2CreateSymlinkResult, Error>

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.