Struct NamedValidationArgument 

pub struct NamedValidationArgument<'a> { /* private fields */ }

One named validator parameter.

Type Parameters

• 'a: Lifetime of the borrowed parameter name and value.

Examples

use qubit_validator::{NamedValidationArgument, ValidationArgument};

let argument = NamedValidationArgument::new(
    "minimum",
    ValidationArgument::Unsigned(3),
);
assert_eq!(argument.name(), "minimum");

Implementations

impl<'a> NamedValidationArgument<'a>

pub const fn new(name: &'a str, value: ValidationArgument<'a>) -> Self

Creates a named parameter.

Parameters

• name: Non-empty name declared by the validator’s parameter schema.
• value: Typed value supplied for that parameter.

Returns

A named parameter retaining the supplied borrowed data.

Panics

Panics when name is empty.

Examples found in repository

examples/local_registry.rs (line 140)

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 name(&self) -> &'a str

Returns the parameter name.

Returns

The name borrowed from this argument.

pub const fn value(&self) -> ValidationArgument<'a>

Returns the parameter value.

Returns

The copyable typed value, which may contain borrowed data.

Trait Implementations

impl<'a> Clone for NamedValidationArgument<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for NamedValidationArgument<'a>

impl Debug for NamedValidationArgument<'_>

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

Omits the parameter name and relies on the value’s redacted formatter.

impl<'a> Eq for NamedValidationArgument<'a>

impl<'a> PartialEq for NamedValidationArgument<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for NamedValidationArgument<'a>