Skip to main content

ValidationContext

Struct ValidationContext 

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

Collects all validation diagnostics emitted during the loading pipeline.

Pass a &mut ValidationContext to each validation function. After all layers have run, call into_result to convert the collected diagnostics into a Result<(), LoadError>.

§Examples

use cobre_io::validation::{ValidationContext, ErrorKind};

let mut ctx = ValidationContext::new();
assert!(!ctx.has_errors());
assert!(ctx.into_result().is_ok());

Implementations§

Source§

impl ValidationContext

Source

pub fn new() -> Self

Creates an empty validation context with no diagnostics.

Source

pub fn add_error( &mut self, kind: ErrorKind, file: impl Into<PathBuf>, entity: Option<impl Into<String>>, message: impl Into<String>, )

Adds an error diagnostic to the context.

Source

pub fn add_warning( &mut self, kind: ErrorKind, file: impl Into<PathBuf>, entity: Option<impl Into<String>>, message: impl Into<String>, )

Adds a warning diagnostic to the context.

Source

pub fn has_errors(&self) -> bool

Returns true if any error-severity diagnostics have been collected.

Source

pub fn error_count(&self) -> usize

Returns the number of error-severity diagnostics without allocating.

Source

pub fn errors(&self) -> Vec<&ValidationEntry>

Returns all error-severity ValidationEntry items.

Source

pub fn warnings(&self) -> Vec<&ValidationEntry>

Returns a slice of all warning-severity ValidationEntry items.

Source

pub fn into_result(self) -> Result<(), LoadError>

Converts the collected diagnostics into a Result.

Warnings are not surfaced by this method — inspect warnings() before calling into_result().

§Errors

Returns LoadError::ConstraintError if any error-severity diagnostics were collected. The description field contains all error messages joined by newlines, formatted as [ErrorKind] file (entity): message.

§Examples
use cobre_io::validation::{ValidationContext, ErrorKind};

let mut ctx = ValidationContext::new();
ctx.add_warning(ErrorKind::UnusedEntity, "system/thermals.json", Some("T1"), "inactive");
assert!(ctx.into_result().is_ok());

Trait Implementations§

Source§

impl Debug for ValidationContext

Source§

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

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

impl Default for ValidationContext

Source§

fn default() -> ValidationContext

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more