Struct Inspector

pub struct Inspector { /* private fields */ }

Root of the Inspect API. Through this API, further nodes can be created and inspect can be served.

Implementations

impl Inspector

pub fn duplicate_vmo(&self) -> Option<Vmo>

Returns a duplicate of the underlying VMO for this Inspector.

The duplicated VMO will be read-only, and is suitable to send to clients over FIDL.

pub fn duplicate_vmo_with_rights(&self, rights: Rights) -> Option<Vmo>

Returns a duplicate of the underlying VMO for this Inspector with the given rights.

The duplicated VMO will be read-only, and is suitable to send to clients over FIDL.

pub fn frozen_vmo_copy(&self) -> Option<Vmo>

This produces a copy-on-write VMO with a generation count marked as VMO_FROZEN. The resulting VMO is read-only.

Failure This function returns None for failure. That can happen for a few reasons.

1. It is a semantic error to freeze a VMO while an atomic transaction is in progress, because that transaction is supposed to be atomic.
2. VMO errors. This can include running out of space or debug assertions.

Note: the generation count for the original VMO is updated immediately. Since the new VMO is page-by-page copy-on-write, at least the first page of the VMO will immediately do a true copy. The practical implications of this depend on implementation details like how large a VMO is versus page size.

pub fn copy_vmo(&self) -> Option<Vmo>

Returns a VMO holding a copy of the data in this inspector.

The copied VMO will be read-only.

impl Inspector

pub fn new(conf: InspectorConfig) -> Self

Initializes a new Inspect VMO object with the default maximum size.

pub fn copy_vmo_data(&self) -> Option<Vec<u8>>

Returns a copy of the bytes stored in the VMO for this inspector.

The output will be truncated to only those bytes that are needed to accurately read the stored data.

pub fn max_size(&self) -> Option<usize>

pub fn is_valid(&self) -> bool

True if the Inspector was created successfully (it’s not No-Op)

pub fn root(&self) -> &Node

Returns the root node of the inspect hierarchy.

pub fn atomic_update<F, R>(&self, update_fn: F) -> R

where F: FnOnce(&Node) -> R,

Takes a function to execute as under a single lock of the Inspect VMO. This function receives a reference to the root of the inspect hierarchy.

Trait Implementations

impl Clone for Inspector

fn clone(&self) -> Inspector

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Inspector

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

Formats the value using the given formatter.

impl Default for Inspector

fn default() -> Self

Returns the “default value” for a type.

impl DiagnosticsHierarchyGetter<String> for Inspector

fn get_diagnostics_hierarchy(&self) -> Cow<'_, DiagnosticsHierarchy>

impl InspectorExt for Inspector

fn record_lazy_stats(&self)

Creates a new stats node that will expose the given Inspector stats.

impl ReadableTree for Inspector

fn vmo<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vmo, ReaderError>> + Send + 'async_trait>>

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

Returns the vmo of the current root node.

fn tree_names<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, ReaderError>> + Send + 'async_trait>>

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

Returns the lazy links names.

fn read_tree<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Self, ReaderError>> + Send + 'async_trait>>

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

Loads the lazy link of the given name.

impl TryFrom<&Inspector> for Snapshot

type Error = ReaderError

The type returned in the event of a conversion error.

fn try_from(inspector: &Inspector) -> Result<Self, Self::Error>

Performs the conversion.