Skip to main content

Rule

Enum Rule 

Source
pub enum Rule {
Show 30 variants Required, Present, NotNull, String, Integer, Numeric, Boolean, Array, Min(f64), Max(f64), Size(f64), Between(f64, f64), Email, Url, Slug, Uuid, Alpha, AlphaNumeric, AlphaDash, In(Vec<String>), NotIn(Vec<String>), StartsWith(String), EndsWith(String), Date, After(NaiveDate), Before(NaiveDate), Confirmed, Same(String), Different(String), Custom { message: String, check: Arc<dyn Fn(&Value) -> bool + Send + Sync>, },
}
Expand description

One validation rule.

Variants§

§

Required

Present, not null, and not empty.

§

Present

Present (may be null or empty).

§

NotNull

Not null when present.

§

String

A string (or a value that reads as one).

§

Integer

An integer.

§

Numeric

A number, integer or not.

§

Boolean

A boolean, or one of the strings a form sends for one.

§

Array

An array.

§

Min(f64)

At least this length: characters for a string, elements for an array, value for a number.

§

Max(f64)

At most this length, by the same measure as Rule::Min.

§

Size(f64)

Exactly this length.

§

Between(f64, f64)

Between these bounds, inclusive.

§

Email

A plausible email address.

§

Url

An absolute http/https URL.

§

Slug

Letters, digits, - and _.

§

Uuid

A canonical UUID.

§

Alpha

ASCII letters only.

§

AlphaNumeric

ASCII letters and digits.

§

AlphaDash

Letters, digits, - and _.

§

In(Vec<String>)

One of these values.

§

NotIn(Vec<String>)

None of these values.

§

StartsWith(String)

Starts with this prefix.

§

EndsWith(String)

Ends with this suffix.

§

Date

A YYYY-MM-DD date.

§

After(NaiveDate)

A date on or after this one.

§

Before(NaiveDate)

A date on or before this one.

§

Confirmed

Equal to another field’s value — password_confirmation.

§

Same(String)

Equal to the named field’s value.

§

Different(String)

Different from the named field’s value.

§

Custom

Any predicate, with the message to use when it fails.

Fields

§message: String

Shown when the predicate returns false.

§check: Arc<dyn Fn(&Value) -> bool + Send + Sync>

The predicate.

Implementations§

Source§

impl Rule

Source

pub fn name(&self) -> &'static str

The rule’s name, as it appears in a failure message.

Source

pub fn applies_to_missing(&self) -> bool

Whether this rule cares about a value that is absent or null.

Only the presence rules do. Everything else defers to them, which is what makes optional fields work without a rule combinator.

Source

pub fn check(&self, field: &str, value: Option<&Value>, all: &Value) -> Outcome

Check value (the field being validated) against this rule.

field names it for the message, and all is the whole input, which the cross-field rules need.

Trait Implementations§

Source§

impl Clone for Rule

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Rule

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Rule

§

impl !UnwindSafe for Rule

§

impl Freeze for Rule

§

impl Send for Rule

§

impl Sync for Rule

§

impl Unpin for Rule

§

impl UnsafeUnpin for Rule

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.