Struct Files 

pub struct Files<S: ?Sized, D: DeliveryHandler> { /* private fields */ }

A thread-safe registry of active File instances indexed by their Zircon pager port key.

Implementations

impl<S: BlockService + ?Sized + 'static, D: DeliveryHandler> Files<S, D>

pub fn new(service: Arc<S>, delivery_handler: D, port: Port) -> Self

Creates a new file registry with the provided block service, delivery handler, and port.

pub fn new_with_shared_handler( service: Arc<S>, delivery_handler: Arc<D>, port: Port, parent: Option<Arc<File>>, ) -> Self

Creates a new file registry sharing an existing Arc<D> delivery handler, optionally mapped as a child session over parent_file.

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

Starts recording a profile of page requests serviced by self.

While active, each serviced page request records a FileMessage containing the file’s Zircon pager port key and the readahead-aligned uncompressed logical byte offset within that file.

Returns Err(zx::Status::BAD_STATE) if a recording is already active.

pub fn is_recording(&self) -> bool

pub fn stop_recording(&self) -> Result<Vmo, Status>

Stops the active profile recording and returns a VMO containing the recorded FileMessage items.

Returns Err(zx::Status::BAD_STATE) if no recording is active.

pub fn abort_recording(&self)

Aborts any active profile recording.

pub fn delivery_handler(&self) -> &Arc<D>

Returns a reference to the DeliveryHandler backing this registry.

pub fn has_parent(&self) -> bool

Returns true if this registry belongs to a child session whose files map logical byte ranges within a parent file.

pub fn spawn_pager_thread(self: &Arc<Self>) -> PagerThread<S, D>

Spawns a background thread to service pager requests for self.

pub fn service(&self) -> &Arc<S>

Returns a reference to the block service.

pub fn register_blob( &self, key: u64, merkle_leaves: &[[u8; 32]], read_alignment: usize, ) -> Result<(), Error>

Registers a blob’s Merkle tree leaf hashes and delivery read alignment with the downstream delivery handler.

pub fn begin_loading(&self, key: u64)

Marks key as currently loading metadata, preserving any page requests that arrived prior to the mapping command.

pub fn get_file(&self, key: u64) -> Option<Arc<File>>

Returns the loaded File registered under key, if present.

pub async fn wait_for_file(&self, key: u64) -> Result<Arc<File>, Error>

Returns a future that completes with the loaded File registered under key, waiting asynchronously if the file is currently loading or hasn’t arrived yet.

pub fn remove(&self, key: u64)

Removes the file registered under key.

impl<S: BlockService + ?Sized + 'static> Files<S, NoopDeliveryHandler>

pub fn new_without_pager(service: Arc<S>) -> Self

Creates a file registry without a pager for intermediate (e.g. partition) sessions.