Struct data_plane_api::validate::StringRules

pub struct StringRules {

    pub const: Option<String>,
    pub len: Option<u64>,
    pub min_len: Option<u64>,
    pub max_len: Option<u64>,
    pub len_bytes: Option<u64>,
    pub min_bytes: Option<u64>,
    pub max_bytes: Option<u64>,
    pub pattern: Option<String>,
    pub prefix: Option<String>,
    pub suffix: Option<String>,
    pub contains: Option<String>,
    pub not_contains: Option<String>,
    pub in: Vec<String>,
    pub not_in: Vec<String>,
    pub strict: Option<bool>,
    pub ignore_empty: Option<bool>,
    pub well_known: Option<WellKnown>,
}

StringRules describe the constraints applied to string values

Fields

const: Option<String>

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 characters (Unicode code points). Note that the number of characters may differ from the number of bytes in the string.

min_len: Option<u64>

MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum. Note that the number of characters may differ from the number of bytes in the string.

max_len: Option<u64>

MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum. Note that the number of characters may differ from the number of bytes in the string.

len_bytes: Option<u64>

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

min_bytes: Option<u64>

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

max_bytes: Option<u64>

MaxBytes 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<String>

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

suffix: Option<String>

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

contains: Option<String>

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

not_contains: Option<String>

NotContains specifies that this field cannot have the specified substring anywhere in the string.

in: Vec<String>

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

not_in: Vec<String>

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

strict: Option<bool>

This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation. By default, this is true, and HTTP header validations are RFC-compliant. Setting to false will enable a looser validations that only disallows \r\n\0 characters, which can be used to bypass header matching rules.

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 string patterns

Implementations

impl StringRules

pub fn const(&self) -> &str

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 min_bytes(&self) -> u64

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

pub fn max_bytes(&self) -> u64

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

pub fn pattern(&self) -> &str

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

pub fn prefix(&self) -> &str

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

pub fn suffix(&self) -> &str

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

pub fn contains(&self) -> &str

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 len_bytes(&self) -> u64

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

pub fn not_contains(&self) -> &str

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

pub fn strict(&self) -> bool

Returns the value of strict, or the default value if strict 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 StringRules

fn clone(&self) -> StringRules

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringRules

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

Formats the value using the given formatter.

impl Default for StringRules

fn default() -> Self

Returns the “default value” for a type.

impl Message for StringRules

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<StringRules> for StringRules

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