Struct ValidationReport 

#[non_exhaustive]
pub struct ValidationReport {
    pub template: String,
    pub method: String,
    pub operation_id: Option<String>,
    pub path_parameters: Vec<(String, String)>,
    pub errors: Vec<ValidationError>,
}

The verdict on one request that the description does describe.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

template: String

The Path Item template the request matched, e.g. /pets/{petId}.

method: String

The HTTP method token the matched operation describes — GET, not the get that OpenAPI keys it under, and exactly as written for one that came from additionalOperations.

operation_id: Option<String>

The matched operation’s operationId, when it has one.

path_parameters: Vec<(String, String)>

Path parameters as the template read them.

errors: Vec<ValidationError>

Everything wrong with the request. Empty means valid.

Implementations

impl ValidationReport

pub fn is_valid(&self) -> bool

Whether the request satisfied the description, with nothing left unchecked.

Both halves matter: see violations and unchecked to tell them apart.

pub fn violations(&self) -> impl Iterator<Item = &ValidationError>

The errors that are definitely the request’s fault.

pub fn unchecked(&self) -> impl Iterator<Item = &ValidationError>

The errors that say a check could not be made — nothing is known to be wrong, and nothing is known to be right.

A validator that reported these as violations would reject valid requests; one that dropped them would call unexamined requests valid. They are kept and labelled so the caller can choose.

pub fn into_result(self) -> Result<Self, Vec<ValidationError>>

The errors, as one Err when there are any.

Errors

The report’s own errors, for callers that would rather branch on a Result than on is_valid.

Trait Implementations

impl Clone for ValidationReport

fn clone(&self) -> ValidationReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationReport

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

Formats the value using the given formatter.

impl Display for ValidationReport

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

Formats the value using the given formatter.

impl Eq for ValidationReport

impl PartialEq for ValidationReport

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ValidationReport