Struct StringSizeRule

pub struct StringSizeRule<const MIN: usize, const MAX: usize>;

A rule that checks the size of a string.

MIN and MAX are inclusive number of bytes.

Example

use validus::prelude::*;

// inclusive
type PasswordRule = StringSizeRule<8, 32>;

// too short
let pw = "1234".validate::<PasswordRule>();
assert!(pw.is_err());

// 4 * 8 + 1 = 33 bytes (too long)
let pw = "aaaabbbbccccddddeeeeffffgggghhhhi".validate::<PasswordRule>();
assert!(pw.is_err());

// good
let pw = "12345678".validate::<PasswordRule>();
assert!(pw.is_ok());

Trait Implementations

impl<const MIN: usize, const MAX: usize> Clone for StringSizeRule<MIN, MAX>

fn clone(&self) -> StringSizeRule<MIN, MAX>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const MIN: usize, const MAX: usize> Debug for StringSizeRule<MIN, MAX>

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

Formats the value using the given formatter.

impl<const MIN: usize, const MAX: usize> Default for StringSizeRule<MIN, MAX>

fn default() -> StringSizeRule<MIN, MAX>

Returns the “default value” for a type.

impl<const MIN: usize, const MAX: usize> Hash for StringSizeRule<MIN, MAX>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const MIN: usize, const MAX: usize> Ord for StringSizeRule<MIN, MAX>

fn cmp(&self, other: &StringSizeRule<MIN, MAX>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const MIN: usize, const MAX: usize> PartialEq for StringSizeRule<MIN, MAX>

fn eq(&self, other: &StringSizeRule<MIN, MAX>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const MIN: usize, const MAX: usize> PartialOrd for StringSizeRule<MIN, MAX>

fn partial_cmp(&self, other: &StringSizeRule<MIN, MAX>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const MIN: usize, const MAX: usize> ValidateString for StringSizeRule<MIN, MAX>

type Error = StringSizeOutOfRangeError

Explain why the string slice is invalid.

fn validate_str(s: &str) -> Result<(), Self::Error>

Validate a string slice.

impl<const MIN: usize, const MAX: usize> Copy for StringSizeRule<MIN, MAX>

impl<const MIN: usize, const MAX: usize> Eq for StringSizeRule<MIN, MAX>

impl<const MIN: usize, const MAX: usize> StructuralPartialEq for StringSizeRule<MIN, MAX>