AnalyzerContext

Struct AnalyzerContext 

Source
pub struct AnalyzerContext { /* private fields */ }
Expand description

Context that stores the results of analyzer computations.

The AnalyzerContext provides a centralized storage for metrics computed by different analyzers, allowing for efficient access and serialization of results.

§Example

use term_guard::analyzers::{AnalyzerContext, MetricValue};

let mut context = AnalyzerContext::new();

// Store metrics from different analyzers
context.store_metric("size", MetricValue::Long(1000));
context.store_metric("completeness.user_id", MetricValue::Double(0.98));

// Retrieve metrics
if let Some(size) = context.get_metric("size") {
    println!("Dataset size: {}", size);
}

// Get all metrics for a specific analyzer
let completeness_metrics = context.get_analyzer_metrics("completeness");

Implementations§

Source§

impl AnalyzerContext

Source

pub fn new() -> Self

Creates a new empty analyzer context.

Source

pub fn with_dataset(dataset_name: impl Into<String>) -> Self

Creates a new context with the given dataset name.

Source

pub fn store_metric(&mut self, key: impl Into<String>, value: MetricValue)

Stores a metric value with the given key.

§Arguments
  • key - The metric key, typically in format “analyzer_name.metric_name”
  • value - The metric value to store
Source

pub fn store_analyzer_metric( &mut self, analyzer_name: &str, metric_name: &str, value: MetricValue, )

Stores a metric with a composite key built from analyzer and metric names.

§Arguments
  • analyzer_name - The name of the analyzer
  • metric_name - The name of the specific metric
  • value - The metric value to store
Source

pub fn get_metric(&self, key: &str) -> Option<&MetricValue>

Retrieves a metric value by key.

Source

pub fn get_analyzer_metrics( &self, analyzer_name: &str, ) -> HashMap<String, &MetricValue>

Retrieves all metrics for a specific analyzer.

Returns metrics whose keys start with the analyzer name followed by a dot.

Source

pub fn all_metrics(&self) -> &HashMap<String, MetricValue>

Returns all stored metrics.

Source

pub fn record_error( &mut self, analyzer_name: impl Into<String>, error: AnalyzerError, )

Records an error that occurred during analysis.

Source

pub fn errors(&self) -> &[AnalysisError]

Returns all recorded errors.

Source

pub fn has_errors(&self) -> bool

Checks if any errors occurred during analysis.

Source

pub fn metadata(&self) -> &AnalysisMetadata

Returns the analysis metadata.

Source

pub fn metadata_mut(&mut self) -> &mut AnalysisMetadata

Returns a mutable reference to the analysis metadata.

Source

pub fn merge(&mut self, other: AnalyzerContext)

Merges another context into this one.

Metrics from the other context will overwrite existing metrics with the same key.

Source

pub fn summary(&self) -> AnalysisSummary

Creates a summary of the analysis results.

Trait Implementations§

Source§

impl Clone for AnalyzerContext

Source§

fn clone(&self) -> AnalyzerContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnalyzerContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AnalyzerContext

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AnalyzerContext

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AnalyzerContext

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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>,

Source§

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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,