Struct package_directory::RootDir

pub struct RootDir<S> { /* private fields */ }

The root directory of Fuchsia package.

Implementations

impl<S: NonMetaStorage> RootDir<S>

pub async fn new(non_meta_storage: S, hash: Hash) -> Result<Arc<Self>, Error>

Loads the package metadata given by hash from non_meta_storage, returning an object representing the package, backed by non_meta_storage.

pub async fn new_with_dropper( non_meta_storage: S, hash: Hash, dropper: Box<dyn OnRootDirDrop> ) -> Result<Arc<Self>, Error>

Loads the package metadata given by hash from non_meta_storage, returning an object representing the package, backed by non_meta_storage. Takes dropper, which will be dropped when the returned RootDir is dropped.

pub async fn new_raw( non_meta_storage: S, hash: Hash, dropper: Option<Box<dyn OnRootDirDrop>> ) -> Result<Self, Error>

Loads the package metadata given by hash from non_meta_storage, returning an object representing the package, backed by non_meta_storage. Takes dropper, which will be dropped when the returned RootDir is dropped. Like new_with_dropper except the returned RootDir is not in an Arc.

pub fn set_dropper( &mut self, dropper: Box<dyn OnRootDirDrop> ) -> Result<(), Box<dyn OnRootDirDrop>>

Sets the dropper. If the dropper was already set, returns dropper in the error.

pub async fn read_file(&self, path: &str) -> Result<Vec<u8>, ReadFileError>

Returns the contents, if present, of the file at object relative path expression path. https://fuchsia.dev/fuchsia-src/concepts/process/namespaces?hl=en#object_relative_path_expressions

pub fn has_file(&self, path: &str) -> bool

Returns true iff there is a file at path, an object relative path expression. https://fuchsia.dev/fuchsia-src/concepts/process/namespaces?hl=en#object_relative_path_expressions

pub fn hash(&self) -> &Hash

Returns the hash of the package.

pub fn external_file_hashes(&self) -> impl ExactSizeIterator<Item = &Hash>

Returns an iterator of the hashes of files stored externally to the package meta.far. May return duplicates.

pub async fn path(&self) -> Result<PackagePath, PathError>

Returns the path of the package as indicated by the “meta/package” file.

pub async fn subpackages(&self) -> Result<MetaSubpackages, SubpackagesError>

Returns the subpackages of the package.

Trait Implementations

impl<S: Debug> Debug for RootDir<S>

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

Formats the value using the given formatter.

impl<S: NonMetaStorage> Directory for RootDir<S>

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

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.

fn open2( self: Arc<Self>, scope: ExecutionScope, path: VfsPath, protocols: ConnectionProtocols, 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.

fn read_dirents<'a, 'async_trait>( &'a self, pos: &'a TraversalPosition, sink: Box<dyn Sink + 'static> ) -> Pin<Box<dyn Future<Output = Result<(TraversalPosition, Box<dyn Sealed + 'static>), Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait,

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

fn register_watcher( self: Arc<Self>, _: ExecutionScope, _: WatchMask, _: 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>, _: usize)

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

impl<S: NonMetaStorage> DirectoryEntry for RootDir<S>

fn entry_info(&self) -> EntryInfo

This method is used to populate ReadDirents() output.

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

Opens this entry.

impl<S: NonMetaStorage> Node for RootDir<S>

fn get_attrs<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<NodeAttributes, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get this node’s attributes.

fn get_attributes<'life0, 'async_trait>( &'life0 self, requested_attributes: NodeAttributesQuery ) -> Pin<Box<dyn Future<Output = Result<NodeAttributes2, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns node attributes (io2).

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<'async_trait>( self: Arc<Self>, _destination_dir: Arc<dyn MutableDirectory>, _name: Name ) -> Pin<Box<dyn Future<Output = Result<(), Status>> + Send + 'async_trait>>

where Self: 'async_trait,

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

Returns information about the filesystem.

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

Opens the node using the node protocol.