Struct fog_pack::validator::StreamLockboxValidator

pub struct StreamLockboxValidator {
    pub comment: String,
    pub max_len: u32,
    pub min_len: u32,
    pub size: bool,
}

Validator for a StreamLockbox. This validator will only pass a StreamLockbox value. Validation passes if:

• The number of bytes in the lockbox is less than or equal to max_len
• The number of bytes in the lockbox is greater than or equal to min_len

Defaults

Fields that aren’t specified for the validator use their defaults instead. The defaults for each field are:

• comment: “”
• max_len: u32::MAX
• min_len: 0
• size: false

Query Checking

Queries for lockboxes are only allowed to use non default values for max_len and min_len if size is set in the schema’s validator.

Fields

comment: String

An optional comment explaining the validator.

max_len: u32

Set the maximum allowed number of bytes.

min_len: u32

Set the minimum allowed number of bytes.

size: bool

If true, queries against matching spots may set the min_len and max_len values to non-defaults.

Implementations

impl StreamLockboxValidator

pub fn new() -> Self

Make a new validator with the default configuration.

pub fn comment(self, comment: impl Into<String>) -> Self

Set a comment for the validator.

pub fn max_len(self, max_len: u32) -> Self

Set the maximum number of allowed bytes.

pub fn min_len(self, min_len: u32) -> Self

Set the minimum number of allowed bytes.

pub fn size(self, size: bool) -> Self

Set whether or not queries can use the max_len and min_len values.

pub fn build(self) -> Validator

Build this into a Validator enum.

Trait Implementations

impl Clone for StreamLockboxValidator

fn clone(&self) -> StreamLockboxValidator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamLockboxValidator

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

Formats the value using the given formatter.

impl Default for StreamLockboxValidator

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StreamLockboxValidator where
    StreamLockboxValidator: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<StreamLockboxValidator> for StreamLockboxValidator

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

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

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

This method tests for !=.

impl Serialize for StreamLockboxValidator

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamLockboxValidator