Struct FieldAttrs

pub struct FieldAttrs {
    pub name: Option<&'static str>,
    pub required: bool,
    pub nonempty: bool,
    pub trim_whitespace: bool,
    pub characters: Option<CharacterSet>,
    pub max_chars: Option<usize>,
    pub max_chars_allowance: usize,
    pub max_depth: Option<usize>,
    pub max_bytes: Option<usize>,
    pub pii: Pii,
    pub retain: bool,
    pub trim: bool,
}

Meta information about a field.

Fields

name: Option<&'static str>

Optionally the name of the field.

required: bool

If the field is required.

nonempty: bool

If the field should be non-empty.

trim_whitespace: bool

Whether to trim whitespace from this string.

characters: Option<CharacterSet>

A set of allowed or denied character ranges for this string.

max_chars: Option<usize>

The maximum char length of this field.

max_chars_allowance: usize

The extra char length allowance on top of max_chars.

max_depth: Option<usize>

The maximum depth of this field.

max_bytes: Option<usize>

The maximum number of bytes of this field.

pii: Pii

The type of PII on the field.

retain: bool

Whether additional properties should be retained during normalization.

trim: bool

Whether the trimming processor is allowed to shorten or drop this field.

Implementations

impl FieldAttrs

pub const fn new() -> Self

Creates default FieldAttrs.

pub const fn required(self, required: bool) -> Self

Sets whether a value in this field is required.

pub const fn nonempty(self, nonempty: bool) -> Self

Sets whether this field can have an empty value.

This is distinct from required. An empty string ("") passes the “required” check but not the “nonempty” one.

pub const fn trim_whitespace(self, trim_whitespace: bool) -> Self

Sets whether whitespace should be trimmed before validation.

pub const fn pii(self, pii: Pii) -> Self

Sets whether this field contains PII.

pub const fn max_chars(self, max_chars: usize) -> Self

Sets the maximum number of characters allowed in the field.

pub const fn retain(self, retain: bool) -> Self

Sets whether additional properties should be retained during normalization.

Trait Implementations

impl Clone for FieldAttrs

fn clone(&self) -> FieldAttrs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldAttrs

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

Formats the value using the given formatter.

impl Default for FieldAttrs

fn default() -> Self

Returns the “default value” for a type.

impl Copy for FieldAttrs