Skip to main content

ValidationResult

Struct ValidationResult 

Source
pub struct ValidationResult {
    pub success: bool,
    pub errors: Vec<String>,
    pub typed_errors: Vec<ValidationError>,
}
Expand description

Result of validating an AppDataDoc against its schema.

Contains both human-readable error strings (for logging / display) and typed ValidationError values (for programmatic inspection). An empty typed_errors list means the document is valid.

Obtain an instance via validate_app_data_doc or MetadataApi::validate_app_data_doc.

§Example

use cow_app_data::{AppDataDoc, validate_app_data_doc};

let result = validate_app_data_doc(&AppDataDoc::new("OK"));
assert!(result.is_valid());
assert!(!result.has_errors());
assert_eq!(result.error_count(), 0);

Fields§

§success: bool

Whether the document is valid (no errors found).

§errors: Vec<String>

Human-readable validation errors (empty when success is true).

Kept as Vec<String> for backwards compatibility with callers that only inspect the string messages; typed errors are in Self::typed_errors.

§typed_errors: Vec<ValidationError>

Structured, typed constraint violations (empty when success is true).

Implementations§

Source§

impl ValidationResult

Source

pub const fn new(success: bool, errors: Vec<String>) -> Self

Construct a ValidationResult from a success flag and human-readable error list.

The typed_errors field is initialised to an empty Vec. Callers typically use validate_app_data_doc instead, which populates both the string errors and typed errors automatically.

§Parameters
  • success — whether the document is valid.
  • errors — human-readable error messages.
§Returns

A new ValidationResult with an empty typed_errors list.

Source

pub const fn is_valid(&self) -> bool

Returns true when validation succeeded (no errors).

Equivalent to checking typed_errors.is_empty(), but stored as a precomputed flag for convenience.

Source

pub const fn has_errors(&self) -> bool

Returns true when at least one constraint violation was found.

The inverse of is_valid.

Source

pub const fn error_count(&self) -> usize

Returns the number of typed constraint violations.

§Returns

0 when the document is valid, > 0 otherwise.

Source

pub fn errors_ref(&self) -> &[ValidationError]

Returns a slice of all typed constraint violations.

Use this for programmatic inspection of validation errors. Each ValidationError variant carries enough context to build a diagnostic message.

§Returns

An empty slice when the document is valid.

Source

pub fn first_error(&self) -> Option<&ValidationError>

Returns the first typed constraint violation, if any.

Useful for quick “fail on first error” workflows.

§Returns

None when the document is valid, Some(&error) otherwise.

Trait Implementations§

Source§

impl Clone for ValidationResult

Source§

fn clone(&self) -> ValidationResult

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ValidationResult

Source§

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

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

impl Display for ValidationResult

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> 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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