Struct fog_pack::validator::StreamIdValidator

pub struct StreamIdValidator {
    pub comment: String,
    pub in_list: Vec<StreamId>,
    pub nin_list: Vec<StreamId>,
    pub query: bool,
}

Validator for a cryptographic StreamId.

This validator will only pass a StreamId value. Validation passes if:

• If the in list is not empty, the StreamId must be among the ones in the list.
• The StreamId must not be among the ones in the nin list.

Defaults

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

• comment: “”
• in_list: empty
• nin_list: empty
• query: false

Fields

comment: String

An optional comment explaining the validator.

in_list: Vec<StreamId>

A vector of specific allowed values, stored under the in field. If empty, this vector is not checked against.

nin_list: Vec<StreamId>

A vector of specific unallowed values, stored under the nin field.

query: bool

If true, queries against matching spots may have values in the in or nin lists.

Implementations

impl StreamIdValidator

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 in_add(self, add: impl Into<StreamId>) -> Self

Add a value to the in list.

pub fn nin_add(self, add: impl Into<StreamId>) -> Self

Add a value to the nin list.

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

Set whether or not queries can use the in and nin lists.

pub fn build(self) -> Validator

Build this into a Validator enum.

Trait Implementations

impl Clone for StreamIdValidator

fn clone(&self) -> StreamIdValidator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamIdValidator

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

Formats the value using the given formatter.

impl Default for StreamIdValidator

fn default() -> Self

Returns the “default value” for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<StreamIdValidator> for StreamIdValidator

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

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

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

This method tests for !=.

impl Serialize for StreamIdValidator

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 StreamIdValidator