Struct ErofsFile 

pub struct ErofsFile { /* private fields */ }

An implementation of an EROFS file backed by a Zircon Pager VMO.

Implementations

impl ErofsFile

pub fn new( volume: Arc<ErofsVolume>, node: FileNode, ) -> Result<Arc<Self>, Status>

Creates a new pager-backed ErofsFile using Arc::new_cyclic to establish a weak self-reference within the registered ErofsPacketReceiver. This permits the file to be kept alive dynamically when being used by clients, and cleaned up when no longer in use.

pub fn fs(&self) -> &ErofsFilesystem

pub fn node(&self) -> &FileNode

pub fn vmo(&self) -> &Vmo

pub fn watch_for_zero_children(&self) -> Result<bool, Status>

Instructs the pager to watch for the VMO_ZERO_CHILDREN signal.

If the VMO is currently held weakly by the packet receiver, this method upgrades it to a Strong reference to prevent the file from being deallocated while clients have active mappings, and registers the signal wait on the VMO. Returns Ok(true) if a transition to Strong occurred.

Trait Implementations

impl DirectoryEntry for ErofsFile

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 File for ErofsFile

fn readable(&self) -> bool

Capabilities:

fn writable(&self) -> bool

fn executable(&self) -> bool

async fn open_file(&self, _options: &FileOptions) -> Result<(), Status>

Called when the file is going to be accessed, typically by a new connection. Flags is the same as the flags passed to flex_fuchsia_io.Node/Open. The following flags are handled by the connection and do not need to be handled inside open():

async fn truncate(&self, _length: u64) -> Result<(), Status>

Truncate the file to length. If there are pending attributes to update (see update_attributes), they should also be flushed at this time. Otherwise, no attributes should be updated, other than size as needed.

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

Get the size of this file. This is used to calculate seek offset relative to the end.

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

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

async fn get_backing_memory(&self, flags: VmoFlags) -> Result<Vmo, Status>

Get a VMO representing this file. If not supported by the underlying filesystem, should return Err(NOT_SUPPORTED).

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

Sync this file’s contents to the storage medium (probably disk). This does not necessarily guarantee that the file will be completely written to disk once the call returns. It merely guarantees that any changes to the file have been propagated to the next layer in the storage stack.

fn allocate( &self, _offset: u64, _length: u64, _mode: AllocateMode, ) -> impl Future<Output = Result<(), Status>> + Send

Preallocate disk space for this range.

fn enable_verity( &self, _options: VerificationOptions, ) -> impl Future<Output = Result<(), Status>> + Send

Set the merkle tree and the descriptor for this file and mark the file as fsverity-enabled.

impl FileLike for ErofsFile

fn open( self: Arc<Self>, scope: ExecutionScope, options: FileOptions, object_request: ObjectRequestRef<'_>, ) -> Result<(), Status>

impl GetEntryInfo for ErofsFile

fn entry_info(&self) -> EntryInfo

This method is used to populate ReadDirents() output.

impl GetVmo for ErofsFile

const PAGER_ON_FIDL_EXECUTOR: bool = true

True if the vmo is pager backed and the pager is serviced by the same executor as the StreamIoConnection.

fn get_vmo(&self) -> &Vmo

Returns the underlying VMO for the node.

impl Node for ErofsFile

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

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

where Self: Sized,

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

Returns information about the filesystem and/or volume.

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.

fn list_extended_attributes( &self, ) -> impl Future<Output = Result<Vec<Vec<u8>>, Status>> + Send

where Self: Sized,

List extended attributes.

fn get_extended_attribute( &self, _name: Vec<u8>, ) -> impl Future<Output = Result<Vec<u8>, Status>> + Send

where Self: Sized,

Get the value for an extended attribute.

fn set_extended_attribute( &self, _name: Vec<u8>, _value: Vec<u8>, _mode: SetExtendedAttributeMode, ) -> impl Future<Output = Result<(), Status>> + Send

where Self: Sized,

Set the value for an extended attribute.

fn remove_extended_attribute( &self, _name: Vec<u8>, ) -> impl Future<Output = Result<(), Status>> + Send

where Self: Sized,

Remove the value for an extended attribute.