Struct Rule 

#[non_exhaustive]
pub struct Rule {
    pub id: String,
    pub field: Option<String>,
    pub kind: RuleKind,
    pub contexts: Vec<String>,
    pub target_criteria: Option<String>,
    pub message: Option<String>,
    pub skip_empty: bool,
    pub severity: Severity,
}

One thing a record has to meet, in some contexts, and perhaps only when it fits.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

What it is known by.

field: Option<String>

The field it is about, where the error shows.

kind: RuleKind

What it asks for.

contexts: Vec<String>

When it applies.

target_criteria: Option<String>

It applies only to records that meet this.

message: Option<String>

What to say, instead of the usual words.

skip_empty: bool

Whether an empty field passes, as it does for all but RuleKind::Required.

severity: Severity

How much not meeting it matters.

Implementations

impl Rule

pub fn new(id: impl Into<String>, kind: RuleKind) -> Self

A rule about the whole record.

pub fn on(field: impl Into<String>, kind: RuleKind) -> Self

A rule about a field.

pub fn required(field: impl Into<String>) -> Self

The field has to have something in it.

pub fn unique(field: impl Into<String>) -> Self

No other record can hold the same in the field.

pub fn range( field: impl Into<String>, min: Option<f64>, max: Option<f64>, ) -> Self

The field has to be within these limits.

pub fn matches(field: impl Into<String>, pattern: impl Into<String>) -> Self

The field has to match this regular expression.

pub fn criteria(id: impl Into<String>, expression: impl Into<String>) -> Self

The record has to meet this expression.

pub fn contexts( self, contexts: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Applies in these contexts, instead of on saving.

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

Applies only to records that meet this.

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

Says this when it fails. {field} is what a field of the record holds, as it shows, and {reference.field} the same of the record a reference points to. {$field} is what the rule’s field is called, {$entity} the entity, {$min} and {$max} the limits.

pub fn severity(self, severity: Severity) -> Self

How much not meeting it matters.

pub fn warning(self) -> Self

People are told, and can go on anyway.

pub fn information(self) -> Self

It goes on, with a note on the field.

pub fn skip_empty(self, skip: bool) -> Self

Whether an empty field passes.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl PartialEq for Rule

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

Equality operator ==.

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

Inequality operator !=.