Struct FxDirectory 

pub struct FxDirectory { /* private fields */ }

Implementations

impl FxDirectory

pub fn directory(&self) -> &Directory<FxVolume>

pub fn volume(&self) -> &Arc<FxVolume>

pub fn store(&self) -> &ObjectStore

pub fn is_deleted(&self) -> bool

pub fn set_deleted(&self)

pub fn check_fscrypt_hard_link_conditions( &self, source_wrapping_key_id: Option<WrappingKeyId>, ) -> Result<(), Status>

As per fscrypt, a user cannot link an unencrypted file into an encrypted directory nor can a user link an encrypted file into a directory encrypted with a different key. Appropriate locks must be held by the caller.

Trait Implementations

impl Directory for FxDirectory

fn deprecated_open( self: Arc<Self>, scope: ExecutionScope, flags: OpenFlags, path: Path, server_end: ServerEnd<NodeMarker>, )

DEPRECATED - Do not implement unless required for backwards compatibility. Called when handling a fuchsia.io/Directory.DeprecatedOpen request.

fn open( self: Arc<Self>, scope: ExecutionScope, path: Path, flags: Flags, object_request: ObjectRequestRef<'_>, ) -> Result<(), Status>

Opens a connection to this item if the path is “.” or a connection to an item inside this one otherwise. path will not contain any “.” or “..” components.

async fn open_async( self: Arc<Self>, scope: ExecutionScope, path: Path, flags: Flags, object_request: ObjectRequestRef<'_>, ) -> Result<(), Status>

Same as Self::open but the implementation is async. This may be more efficient if the directory needs to do async work to open the connection.

async fn read_dirents( &self, pos: &TraversalPosition, sink: Box<dyn Sink>, ) -> Result<(TraversalPosition, Box<dyn Sealed>), Status>

Reads directory entries starting from pos by adding them to sink. Once finished, should return a sealed sink.

fn register_watcher( self: Arc<Self>, scope: ExecutionScope, mask: WatchMask, watcher: DirectoryWatcher, ) -> Result<(), Status>

Register a watcher for this directory. Implementations will probably want to use a Watcher to manage watchers.

fn unregister_watcher(self: Arc<Self>, key: usize)

Unregister a watcher from this directory. The watcher should no longer receive events.

impl DirectoryEntry for FxDirectory

fn open_entry(self: Arc<Self>, request: OpenRequest<'_>) -> Result<(), Status>

Opens this entry.

fn scope(&self) -> Option<ExecutionScope>

The scope that should own connections to this directory entry, or None if parent scope should be used (the default).

impl Drop for FxDirectory

fn drop(&mut self)

Executes the destructor for this type.

impl From<Directory<FxVolume>> for FxDirectory

fn from(dir: Directory<FxVolume>) -> Self

Converts to this type from the input type.

impl FxNode for FxDirectory

fn object_id(&self) -> u64

fn parent(&self) -> Option<Arc<FxDirectory>>

fn set_parent(&self, parent: Arc<FxDirectory>)

fn open_count_add_one(&self)

fn open_count_sub_one(self: Arc<Self>)

Atomically check if this brought the count to zero while the node is marked for purge. If so, this must queue the node for tombstone the node.

fn object_descriptor(&self) -> ObjectDescriptor

fn mark_to_be_purged(&self)

Marks the object to be purged. Queues the node for tombstone if open count is zero.

fn terminate(&self)

Called when the filesystem is shutting down. Implementations should break any strong reference cycles that would prevent the node from being dropped.

impl GetEntryInfo for FxDirectory

fn entry_info(&self) -> EntryInfo

This method is used to populate ReadDirents() output.

impl MutableDirectory for FxDirectory

fn link<'a>( self: Arc<Self>, name: String, source_dir: Arc<dyn Any + Send + Sync>, source_name: &'a str, ) -> BoxFuture<'a, Result<(), Status>>

Adds a child entry to this directory. If the target exists, it should fail with ZX_ERR_ALREADY_EXISTS.

async fn unlink( self: Arc<Self>, name: &str, must_be_directory: bool, ) -> Result<(), Status>

Removes an entry from this directory.

async fn update_attributes( &self, attributes: MutableNodeAttributes, ) -> Result<(), Status>

Set the mutable attributes of this directory based on the values in attributes. If the directory does not support updating all of the specified attributes, implementations should fail with ZX_ERR_NOT_SUPPORTED.

async fn sync(&self) -> Result<(), Status>

Syncs the directory.

fn rename( self: Arc<Self>, src_dir: Arc<dyn MutableDirectory>, src_name: Path, dst_name: Path, ) -> BoxFuture<'static, Result<(), Status>>

Renames into this directory.

async fn create_symlink( &self, name: String, target: Vec<u8>, connection: Option<ServerEnd<SymlinkMarker>>, ) -> Result<(), Status>

Creates a symbolic link.

impl Node for FxDirectory

async fn get_attributes( &self, requested_attributes: NodeAttributesQuery, ) -> Result<NodeAttributes2, Status>

Returns node attributes (io2).

fn query_filesystem(&self) -> Result<FilesystemInfo, Status>

Returns information about the filesystem and/or volume.

async fn list_extended_attributes(&self) -> Result<Vec<Vec<u8>>, Status>

List extended attributes.

async fn get_extended_attribute(&self, name: Vec<u8>) -> Result<Vec<u8>, Status>

Get the value for an extended attribute.

async fn set_extended_attribute( &self, name: Vec<u8>, value: Vec<u8>, mode: SetExtendedAttributeMode, ) -> Result<(), Status>

Set the value for an extended attribute.

async fn remove_extended_attribute(&self, name: Vec<u8>) -> Result<(), Status>

Remove the value for an extended attribute.

fn will_open_as_node(&self) -> Result<(), Status>

Called when the node is about to be opened as the node protocol. Implementers can use this to perform any initialization or reference counting. Errors here will result in the open failing. By default, this forwards to the infallible will_clone.

fn will_clone(&self)

Called when the node is about to be cloned (and also by the default implementation of will_open_as_node). Implementations that perform their own open count can use this. Each call to will_clone will be accompanied by an eventual call to close.

fn close(self: Arc<Self>)

Called when the node is closed.

fn link_into( self: Arc<Self>, _destination_dir: Arc<dyn MutableDirectory>, _name: Name, ) -> impl Future<Output = Result<(), Status>> + Send

where Self: Sized,

fn open_as_node( self: Arc<Self>, scope: ExecutionScope, options: NodeOptions, object_request: &mut ObjectRequest, ) -> Result<(), Status>

where Self: Sized,

Opens the node using the node protocol.

impl RootDir for FxDirectory

fn as_directory_entry(self: Arc<Self>) -> Arc<dyn DirectoryEntry>

fn serve(self: Arc<Self>, flags: Flags, server_end: ServerEnd<DirectoryMarker>)

fn as_node(self: Arc<Self>) -> Arc<dyn FxNode>

fn register_additional_volume_services( self: Arc<Self>, _svc_dir: &Simple, ) -> Result<(), Error>

impl ToWeakNode for FxDirectory

fn to_weak_node(self: Arc<Self>) -> WeakNode