Skip to main content

SkippedValidation

Struct SkippedValidation 

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

One validation occurrence that was skipped by the executor.

§Examples

use qubit_validator::{SkipReason, SkippedValidation, ValidationPath};

let skipped = SkippedValidation::missing_optional(
    0,
    ValidationPath::root().with_field("optional"),
);
assert_eq!(skipped.reason(), SkipReason::MissingOptional);

Implementations§

Source§

impl SkippedValidation

Source

pub fn missing_optional(occurrence: usize, path: ValidationPath) -> Self

Creates a record for an absent optional target.

§Parameters
  • occurrence: Zero-based declaration position of the skipped target.
  • path: Structured path identifying the absent target.
§Returns

A skipped occurrence with no prerequisite failures.

Source

pub fn failed_prerequisite( occurrence: usize, path: ValidationPath, prerequisites: Vec<FailureId>, ) -> Result<Self, ValidationOutcomeError>

Creates a record for an occurrence skipped after prerequisite failures.

§Parameters
  • occurrence: Zero-based declaration position of the skipped target.
  • path: Structured path identifying the skipped target.
  • prerequisites: Failure IDs that prevented this occurrence from running.
§Errors

Returns EmptyPrerequisites when no failure ID is supplied.

§Returns

A skipped occurrence containing the supplied prerequisite failure IDs.

Source

pub const fn occurrence(&self) -> usize

Returns the zero-based declaration occurrence assigned by the executor.

§Returns

The occurrence number used to order this validation result.

Source

pub const fn path(&self) -> &ValidationPath

Returns the structured path of the skipped target.

§Returns

A borrow of the target path stored in this record.

Source

pub const fn reason(&self) -> SkipReason

Returns why the executor did not run this occurrence.

§Returns

The policy reason that caused the skip.

Source

pub fn prerequisites(&self) -> &[FailureId]

Returns IDs of failures that prevented this occurrence.

§Returns

The prerequisite IDs, or an empty slice when an optional target was absent.

Trait Implementations§

Source§

impl Clone for SkippedValidation

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SkippedValidation

Source§

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

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

impl Eq for SkippedValidation

Source§

impl PartialEq for SkippedValidation

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SkippedValidation

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.