Struct Violations 

pub struct Violations {
    pub violations: Vec<Violation>,
}

Available on crate feature protovalidate only.

Violations is a collection of Violation messages. This message type is returned by Protovalidate when a proto message fails to meet the requirements set by the Rule validation rules. Each individual violation is represented by a Violation message.

Fields

violations: Vec<Violation>

violations is a repeated field that contains all the Violation messages corresponding to the violations detected.

Implementations

impl Violations

pub fn violation_by_rule_id(&self, rule_id: &str) -> Option<&Violation>

Searches for a violation with a specific rule id.

pub fn violation_by_field_path(&self, path: &str) -> Option<&Violation>

Searches for a violation with a specific field_path string.

Keep in mind the field_path will include Subscripts like vector indexes or map keys.

Examples

use proto_types::protovalidate::{FieldPath, FieldPathElement, Violation, Violations};

let violations = Violations {
   violations: vec![Violation {
     field: Some(FieldPath {
       elements: vec![
         FieldPathElement {
           field_name: Some("person".to_string()),
           ..Default::default()
         },
         FieldPathElement {
           field_name: Some("name".to_string()),
           ..Default::default()
         },
       ],
     }),
     ..Default::default()
   }],
 };
 assert!(violations.violation_by_field_path("person.name").is_some());

Trait Implementations

impl Clone for Violations

fn clone(&self) -> Violations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Violations

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

Formats the value using the given formatter.

impl Default for Violations

fn default() -> Self

Returns the “default value” for a type.

impl From<Violations> for Status

fn from(value: Violations) -> Self

Converts to this type from the input type.

impl Message for Violations

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Violations

fn eq(&self, other: &Violations) -> 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 StructuralPartialEq for Violations