Skip to main content

ValidationOutcome

Enum ValidationOutcome 

Source
#[non_exhaustive]
pub enum ValidationOutcome { Success(Vec<Diagnostic>), IoError(FileError), Skipped, }
Expand description

Outcome of validating a single file.

Returned by crate::validate_file and crate::validate_file_with_registry. The Ok path of LintResult<ValidationOutcome> covers all per-file situations - successful validation, I/O errors, and skipped files - while the Err path is reserved for config-level errors (e.g. invalid exclude patterns, too many files).

Use into_diagnostics() for a quick migration path from the previous Vec<Diagnostic> return type.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Success(Vec<Diagnostic>)

Validation ran successfully. The contained diagnostics may be empty (no issues found) or non-empty (issues found).

§

IoError(FileError)

The file could not be read due to an I/O or filesystem error.

§

Skipped

The file type is unknown and no validation was performed.

Implementations§

Source§

impl ValidationOutcome

Source

pub fn is_success(&self) -> bool

Returns true if validation ran (regardless of whether diagnostics were found).

Source

pub fn is_io_error(&self) -> bool

Returns true if the file could not be read.

Source

pub fn is_skipped(&self) -> bool

Returns true if the file was skipped (unknown file type).

Source

pub fn diagnostics(&self) -> &[Diagnostic]

Borrow the diagnostics from a successful validation.

Returns an empty slice for IoError and Skipped variants.

Source

pub fn into_diagnostics(self) -> Vec<Diagnostic>

Consume the outcome and return the diagnostics.

  • Success: returns the contained diagnostics.
  • IoError: returns a single file::read diagnostic describing the error.
  • Skipped: returns an empty Vec.
Source

pub fn io_error(&self) -> Option<&FileError>

If this is an IoError, return a reference to the underlying FileError.

Trait Implementations§

Source§

impl Debug for ValidationOutcome

Source§

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

Formats the value using the given formatter. Read more

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.