Struct RegistrationSource 

pub struct RegistrationSource { /* private fields */ }

Source location for one linked registration.

Examples

use qubit_validator::RegistrationSource;

let source = RegistrationSource::new("rules", "rules::text", "src/text.rs", 12);
assert_eq!(source.crate_name(), "rules");
assert_eq!(source.line(), 12);

Implementations

impl RegistrationSource

pub const fn new( crate_name: &'static str, module_path: &'static str, file: &'static str, line: u32, ) -> Self

Creates the source location of a validator registration.

crate_name, module_path, and file identify the declaring crate, module, and source file, while line is the one-based source line. All text fields must live for the duration of the program. This constructor only stores the supplied metadata and does not access the file system. It can be used for local registrations as well as the registrations generated by register_validator!.

Parameters

• crate_name - Cargo package which declared the registration.
• module_path - Rust module path which declared the registration.
• file - Source file recorded at compile time.
• line - One-based source line recorded at compile time.

Returns

Returns the source location containing the supplied metadata.

Examples found in repository

examples/local_registry.rs (line 154)

fn main() -> Result<(), Box<dyn Error>> {
    let registration = ValidatorRegistration::new(
        ValidatorId::new("text.non_blank"),
        &DESCRIPTOR,
        RegistrationSource::new(env!("CARGO_PKG_NAME"), module_path!(), file!(), line!()),
    );
    let registry = ValidatorRegistry::from_registrations([registration])?;

    assert!(registry.get("text.non_blank").is_some());
    let validator = registry.bind("text.non_blank", InputType::Text, &[])?;
    let context = BoundValidationContext::new(&[]);

    let valid = validator.validate(ValidationValue::Text("Ada"), &context)?;
    assert_eq!(valid, ValidationOutcome::Valid);

    let invalid = validator.validate(ValidationValue::Text("   "), &context)?;
    let ValidationOutcome::Invalid(violations) = invalid else {
        panic!("blank text must be invalid");
    };
    assert_eq!(violations.len(), 1);
    assert_eq!(violations[0].code(), ViolationCode::new("text.blank"));

    assert_dependency_specs_come_from_signature()?;
    assert_parameters_are_consumed_once()?;

    #[cfg(feature = "inventory")]
    {
        let global = ValidatorRegistry::try_global()?;
        assert!(global.get("text.non_blank.global").is_some());
    }

    Ok(())
}

pub const fn crate_name(&self) -> &'static str

Returns the declaring crate name.

Returns

Returns the Cargo package name stored in this source location.

pub const fn module_path(&self) -> &'static str

Returns the declaring module path.

Returns

Returns the Rust module path stored in this source location.

pub const fn file(&self) -> &'static str

Returns the source file path.

Returns

Returns the compile-time source file path stored in this location.

pub const fn line(&self) -> u32

Returns the one-based source line.

Returns

Returns the compile-time line number stored in this location.

Trait Implementations

impl Clone for RegistrationSource

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RegistrationSource

impl Debug for RegistrationSource

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

Formats the value using the given formatter.

impl Eq for RegistrationSource

impl Ord for RegistrationSource

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for RegistrationSource

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RegistrationSource

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for RegistrationSource