pub struct ArchiveReader { /* private fields */ }
Expand description

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

Implementations§

source§

impl ArchiveReader

source

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.
source

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

source

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

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

source

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

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

source

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

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

source

pub fn add_selectors<T, S>(&mut self, selectors: T) -> &mut Self
where T: Iterator<Item = S>, S: ToSelectorArguments,

source

pub fn with_timeout(&mut self, duration: Duration) -> &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.

source

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

source

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”.

source

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.

source

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

Connects to the ArchiveAccessor and returns data matching provided selectors.

source

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.

source

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

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

source

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§

source§

impl Clone for ArchiveReader

source§

fn clone(&self) -> ArchiveReader

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoAny for T
where T: 'static + Send + Sync,

§

fn into_any(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Cast the given object into a dyn std::any::Any.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more