Enum ConvergenceConfigError 

pub enum ConvergenceConfigError {
    WindowTooSmall {
        actual: usize,
    },
    ThresholdOutOfRange {
        actual: f32,
    },
}

Error returned when ConvergenceConfig validation fails.

ConvergenceDetector::new validates the configuration before constructing a detector. If any constraint is violated, it returns one of these variants with enough context to produce an actionable diagnostic message.

Example

use loopctl::detection::convergence::{ConvergenceConfig, ConvergenceDetector, ConvergenceConfigError};

let bad_config = ConvergenceConfig {
    window_size: 1,
    ..Default::default()
};
let err = ConvergenceDetector::new(bad_config).unwrap_err();
assert!(matches!(err, ConvergenceConfigError::WindowTooSmall { actual: 1 }));

Variants

WindowTooSmall

window_size is below the minimum of 2.

Convergence requires at least one pair of consecutive responses, so a window of 1 (or 0) is meaningless.

Fields

actual: usize

The invalid window size that was provided.

Captured verbatim from ConvergenceConfig::window_size so the diagnostic can report the offending value (e.g. 0 or 1) alongside the required minimum of 2.

ThresholdOutOfRange

similarity_threshold is outside the valid range [0.0, 1.0].

Jaccard similarity always produces a value in this range; a threshold outside it would never (or always) trigger.

Fields

actual: f32

The invalid threshold value that was provided.

Captured verbatim from ConvergenceConfig::similarity_threshold so the diagnostic can report the out-of-range value (e.g. 1.5 or -0.2) alongside the required [0.0, 1.0] interval.

Trait Implementations

impl Clone for ConvergenceConfigError

fn clone(&self) -> ConvergenceConfigError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConvergenceConfigError

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

Formats the value using the given formatter.

impl Display for ConvergenceConfigError

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

Formats the value using the given formatter.

impl Error for ConvergenceConfigError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for ConvergenceConfigError

fn eq(&self, other: &ConvergenceConfigError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ConvergenceConfigError