Struct ArchiveReader

pub struct ArchiveReader<T> { /* private fields */ }

Utility for reading inspect data of a running component using the injected Archive Reader service.

Implementations

impl<T: DiagnosticsDataType> ArchiveReader<T>

pub fn with_archive(&mut self, archive: ArchiveAccessorProxy) -> &mut Self

Initializes the ArchiveReader with a custom connection to an ArchiveAccessor. By default, the connection will be initialized by connecting to fuchsia.diagnostics.ArchiveAccessor

pub fn with_minimum_schema_count( &mut self, minimum_schema_count: usize, ) -> &mut Self

Sets the minimum number of schemas expected in a result in order for the result to be considered a success.

pub fn retry(&mut self, config: RetryConfig) -> &mut Self

Sets a custom retry configuration. By default we always retry.

pub fn with_timeout(&mut self, duration: MonotonicDuration) -> &mut Self

Sets the maximum time to wait for a response from the Archive. Do not use in tests unless timeout is the expected behavior.

pub fn select_all_for_component( &mut self, component: impl ToComponentSelectorArguments, ) -> &mut Self

Filters logs for a specific component or component selector. If string input, the string may be either a component selector string or a moniker, or a ComponentSelector may be passed directly.

impl ArchiveReader<Logs>

pub fn logs() -> Self

Creates an ArchiveReader for reading logs

pub async fn snapshot(&self) -> Result<Vec<Data<Logs>>, Error>

Connects to the ArchiveAccessor and returns data matching provided selectors.

pub fn snapshot_then_subscribe(&self) -> Result<Subscription, Error>

Connects to the ArchiveAccessor and returns a stream of data containing a snapshot of the current buffer in the Archivist as well as new data that arrives.

impl ArchiveReader<Inspect>

pub fn inspect() -> Self

Creates an ArchiveReader for reading Inspect data.

pub fn with_batch_retrieval_timeout_seconds( &mut self, timeout: i64, ) -> &mut Self

Set the maximum time to wait for a wait for a single component to have its diagnostics data “pumped”.

pub fn with_aggregated_result_bytes_limit( &mut self, limit_bytes: u64, ) -> &mut Self

Sets the total number of bytes allowed in a single VMO read.

pub async fn snapshot_raw<T>(&self) -> Result<T, Error>

where T: for<'a> Deserialize<'a> + SerializableValue + From<Vec<T>> + CheckResponse + 'static + Send,

Connects to the ArchiveAccessor and returns inspect data matching provided selectors. Returns the raw json for each hierarchy fetched. This is used for CTF compatibility tests (which test various implementation details of the JSON format), and use beyond such tests is discouraged.

pub fn add_selectors<T, S>(&mut self, selectors: T) -> &mut Self

where T: Iterator<Item = S>, S: ToSelectorArguments,

Adds selectors used for performing filtering inspect hierarchies. This may be called multiple times to add additional selectors.

pub fn add_selector(&mut self, selector: impl ToSelectorArguments) -> &mut Self

Requests a single component tree (or sub-tree).

pub async fn snapshot(&self) -> Result<Vec<Data<Inspect>>, Error>

Connects to the ArchiveAccessor and returns data matching provided selectors.