Struct File 

pub struct File { /* private fields */ }

A mapped file containing extents and an optional transformation (compression or encryption).

Implementations

impl File

pub fn new( extents: Extents, uncompressed_size: u64, transform: Transform, ) -> Self

pub fn extents(&self) -> &Extents

Returns the extents mapping logical offsets to device offsets.

pub fn uncompressed_size(&self) -> u64

Returns the uncompressed size of the file in bytes.

pub fn transform(&self) -> &Transform

Returns the transform applied to the file if compressed or encrypted.

pub fn compression_info(&self) -> Option<&CompressionInfo>

Returns decompression metadata if the file is compressed.

pub fn cipher(&self) -> Option<&Arc<dyn Cipher>>

Returns the cipher if the file is encrypted.

pub fn read_ahead_size(&self) -> u64

Returns the read-ahead window size in bytes for this file.

pub fn verification_alignment(&self) -> u64

Returns the Merkle verification alignment in bytes for this file (chunk_size for compressed files, or DEFAULT_VERIFICATION_ALIGNMENT for uncompressed/encrypted files).

pub fn read_range( self: &Arc<Self>, service: &(impl BlockService + ?Sized), page_request: impl PageRequest, )

Streams and decodes the uncompressed range requested by page_request, applying readahead.

pub fn read_range_with_alignment( self: &Arc<Self>, window_alignment: u64, service: &(impl BlockService + ?Sized), page_request: impl PageRequest, )

Streams and decodes the uncompressed range requested by page_request, aligning the read window to window_alignment and delivering chunks at self.verification_alignment().

Unlike Self::read_range (which expands the read window to self.read_ahead_size()), this allows a caller (such as a child file mapping) to bound the read window to a smaller alignment (e.g. a single verification chunk of the parent file).

pub fn read_child_range<D: DeliveryHandler>( self: &Arc<Self>, child_key: u64, original_range: Range<u64>, parent_file: &Arc<File>, service: &(impl BlockService + ?Sized), delivery_handler: &Arc<D>, ) -> bool

Services a page request for a child file (self, identified by child_key) whose extents map to logical byte offsets in parent_file.

Expands original_range to self.read_ahead_size() and iterates over the overlapping child extents:

• [DeviceExtent::Sparse]: notifies delivery_handler via DeliveryHandler::deliver_child_sparse to zero-fill the child slice.
• [DeviceExtent::Block]: reads the corresponding byte range of parent_file aligned to parent_file.verification_alignment() so the downstream verifier can verify the parent chunks before supplying the child VMO pages.
• [DeviceExtent::InlineTail]: enqueues a header-only command via DeliveryHandler::deliver_child_inline_tail so the verifier can copy the tail bytes directly from the verified parent VMO without performing additional block I/O.

Returns true if at least one asynchronous block read was initiated.