Struct ArchiveReader

pub struct ArchiveReader { /* private fields */ }

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

Implementations

impl ArchiveReader

pub fn new() -> Self

Creates a new data fetcher with default configuration:

• Maximum retries: 2^64-1
• Timeout: Never. Use with_timeout() to set a timeout.

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

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

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

pub fn select_all_for_moniker(&mut self, moniker: &str) -> &mut Self

Requests all data for the component identified by the given moniker.

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

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

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

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

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 with_aggregated_result_bytes_limit( &mut self, limit_bytes: u64, ) -> &mut Self

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_minimum_schema_count( &mut self, minimum_schema_count: usize, ) -> &mut Self

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

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

where D: DiagnosticsData,

Connects to the ArchiveAccessor and returns data matching provided selectors.

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

where D: DiagnosticsData + 'static,

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.

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

where D: DiagnosticsData, T: for<'a> Deserialize<'a> + SerializableValue + From<Vec<T>> + CheckResponse,

Connects to the ArchiveAccessor and returns inspect data matching provided selectors. Returns the raw json for each hierarchy fetched.

pub fn snapshot_then_subscribe_raw<D, T>( &self, ) -> Result<Subscription<T>, Error>

where D: DiagnosticsData + 'static, T: for<'a> Deserialize<'a> + Send + SerializableValue + 'static,

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.

Trait Implementations

impl Clone for ArchiveReader

fn clone(&self) -> ArchiveReader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ArchiveReader

fn default() -> Self

Returns the “default value” for a type.