Struct BindError 

pub struct BindError { /* private fields */ }

A binding error that does not retain raw parameter values.

Examples

use qubit_validator::{BindError, BindErrorKind};

let error = BindError::new(BindErrorKind::MissingParameter).with_parameter("minimum");
assert_eq!(error.parameter(), Some("minimum"));
assert!(!error.to_string().contains("secret value"));

Implementations

impl BindError

pub fn new(kind: BindErrorKind) -> Self

Creates a binding error for the supplied failure category.

Parameters

• kind: Stable category describing why binding failed.

Returns

A new error without an associated rule, parameter, or dependency.

pub const fn kind(&self) -> BindErrorKind

Returns the error kind.

Returns

The stable category describing the binding failure.

Examples found in repository

examples/local_registry.rs (line 146)

fn assert_parameters_are_consumed_once() -> Result<(), BindError> {
    let args = [NamedValidationArgument::new("limit", ValidationArgument::Unsigned(10))];
    let mut reader = ArgumentReader::new(&args)?;
    assert_eq!(reader.required_u32("limit")?, 10);
    let error = reader
        .required_u32("limit")
        .expect_err("a parameter cannot be read twice");
    assert_eq!(error.kind(), BindErrorKind::ParameterAlreadyConsumed);
    Ok(())
}

pub const fn rule_id(&self) -> Option<ValidatorId>

Returns the resolved rule identifier attached to this error, if any.

A registry lookup that fails with MissingRule has no resolved ValidatorId, so this returns None. The caller retains the requested ID text when it needs to report which lookup failed.

Returns

The resolved identifier for a selected rule, or None when no rule was selected.

pub fn parameter(&self) -> Option<&str>

Returns the associated parameter name, if any.

The error never retains the corresponding raw parameter value.

Returns

Returns Some when a parameter has been attached, or None otherwise.

pub fn dependency(&self) -> Option<&str>

Returns the associated dependency name, if any.

The error never retains the corresponding raw dependency value.

Returns

Returns Some when a dependency has been attached, or None otherwise.

pub const fn with_rule(self, rule_id: ValidatorId) -> Self

Associates the resolved rule identifier with this error.

Parameters

• rule_id: Identifier of the rule whose binding failed.

Returns

This error with the identifier attached.

pub fn with_parameter(self, parameter: impl Into<String>) -> Self

Associates a parameter name with this error without retaining its value.

Parameters

• parameter: Name of the parameter involved in the failure.

Returns

This error with the parameter name attached.

pub fn with_dependency(self, dependency: impl Into<String>) -> Self

Associates a dependency name with this error without retaining its value.

Parameters

• dependency: Name of the dependency involved in the failure.

Returns

This error with the dependency name attached.

Trait Implementations

impl Debug for BindError

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

Formats structural metadata without exposing raw parameter values.

impl Display for BindError

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

Formats a stable summary without exposing raw parameter values.

impl Error for BindError

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.