Struct data_plane_api::validate::BytesRules

pub struct BytesRules {
    pub const: Option<Vec<u8>>,
    pub len: Option<u64>,
    pub min_len: Option<u64>,
    pub max_len: Option<u64>,
    pub pattern: Option<String>,
    pub prefix: Option<Vec<u8>>,
    pub suffix: Option<Vec<u8>>,
    pub contains: Option<Vec<u8>>,
    pub in: Vec<Vec<u8>>,
    pub not_in: Vec<Vec<u8>>,
    pub ignore_empty: Option<bool>,
    pub well_known: Option<WellKnown>,
}

BytesRules describe the constraints applied to bytes values

Fields

const: Option<Vec<u8>>

Const specifies that this field must be exactly the specified value

len: Option<u64>

Len specifies that this field must be the specified number of bytes

min_len: Option<u64>

MinLen specifies that this field must be the specified number of bytes at a minimum

max_len: Option<u64>

MaxLen specifies that this field must be the specified number of bytes at a maximum

pattern: Option<String>

Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters.

prefix: Option<Vec<u8>>

Prefix specifies that this field must have the specified bytes at the beginning of the string.

suffix: Option<Vec<u8>>

Suffix specifies that this field must have the specified bytes at the end of the string.

contains: Option<Vec<u8>>

Contains specifies that this field must have the specified bytes anywhere in the string.

in: Vec<Vec<u8>>

In specifies that this field must be equal to one of the specified values

not_in: Vec<Vec<u8>>

NotIn specifies that this field cannot be equal to one of the specified values

ignore_empty: Option<bool>

IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty

well_known: Option<WellKnown>

WellKnown rules provide advanced constraints against common byte patterns

Implementations

impl BytesRules

pub fn const(&self) -> &[u8]

Returns the value of const, or the default value if const is unset.

pub fn min_len(&self) -> u64

Returns the value of min_len, or the default value if min_len is unset.

pub fn max_len(&self) -> u64

Returns the value of max_len, or the default value if max_len is unset.

pub fn pattern(&self) -> &str

Returns the value of pattern, or the default value if pattern is unset.

pub fn prefix(&self) -> &[u8]

Returns the value of prefix, or the default value if prefix is unset.

pub fn suffix(&self) -> &[u8]

Returns the value of suffix, or the default value if suffix is unset.

pub fn contains(&self) -> &[u8]

Returns the value of contains, or the default value if contains is unset.

pub fn len(&self) -> u64

Returns the value of len, or the default value if len is unset.

pub fn ignore_empty(&self) -> bool

Returns the value of ignore_empty, or the default value if ignore_empty is unset.

Trait Implementations

impl Clone for BytesRules

fn clone(&self) -> BytesRules

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BytesRules

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

Formats the value using the given formatter.

impl Default for BytesRules

fn default() -> Self

Returns the “default value” for a type.

impl Message for BytesRules

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
    B: BufMut,
    Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where
    Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
    B: BufMut,
    Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where
    Self: Sized,

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

fn decode<B>(buf: B) -> Result<Self, DecodeError>where
    B: Buf,
    Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
    B: Buf,
    Self: Default,

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

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
    B: Buf,
    Self: Sized,

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

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
    B: Buf,
    Self: Sized,

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

impl PartialEq<BytesRules> for BytesRules

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for BytesRules