Struct ValidationCtx 

#[non_exhaustive]
pub struct ValidationCtx {
    pub field_context: Option<FieldContext>,
    pub parent_elements: Vec<FieldPathElement>,
    pub violations: ValidationErrors,
    pub fail_fast: bool,
}

The context for a given validation execution.

ℹ️ NOTE: By default, fail_fast is set to true even if this is slightly unitiomatic for a boolean, because this is by far the most desired behaviour for most applications.

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.

field_context: Option<FieldContext>

The context for the element being validated. Can be absent in case the validation is happening at the top level.

parent_elements: Vec<FieldPathElement>

violations: ValidationErrors

fail_fast: bool

Whether validation should be interrupted at the first failure.

Implementations

impl ValidationCtx

pub const fn new() -> Self

Default values for ValidationCtx.

NOTE: By default, fail_fast is set to true even if this is slightly unitiomatic for a boolean, because this is by far the most desired behaviour for most applications.

pub fn without_field_context(&mut self) -> &mut Self

Sets the FieldContext to None.

Mainly useful for validators defined at the top level of a oneof or an unnested message, which do not have a proto field context (tag, name, etc) of their own.

pub fn with_field_context(&mut self, field_context: FieldContext) -> &mut Self

Mutates the FieldContext.

pub fn add_violation( &mut self, kind: ViolationKind, error_message: impl Into<String>, ) -> ValidationResult

Adds a new known violation to the list of errors.

pub fn field_kind(&self) -> FieldKind

Extracts the FieldKind. If the FieldContext is absent (for a top level validator), it falls back to FieldKind::Normal.

pub fn add_violation_with_custom_id( &mut self, rule_id: impl Into<String>, kind: ViolationKind, error_message: impl Into<String>, ) -> ValidationResult

Adds a new known violation to the list of errors, overriding the rule ID.

pub fn add_cel_violation(&mut self, rule: &CelRule) -> ValidationResult

Adds a new violation related to a CelRule.

pub fn add_required_violation( &mut self, error_message: Option<String>, ) -> ValidationResult

Adds a violation for a required field. If no custom error message is specified, the default will be used.

Trait Implementations

impl Clone for ValidationCtx

fn clone(&self) -> ValidationCtx

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationCtx

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

Formats the value using the given formatter.

impl Default for ValidationCtx

fn default() -> Self

Default values for ValidationCtx.

NOTE: By default, fail_fast is set to true even if this is slightly unitiomatic for a boolean, because this is by far the most desired behaviour for most applications.

impl Hash for ValidationCtx

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ValidationCtx

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ValidationCtx

impl StructuralPartialEq for ValidationCtx