Skip to main content

RuleBuilder

Struct RuleBuilder 

Source
pub struct RuleBuilder<'a, R, V, E: PartialEq + Eq + Send + Sync> { /* private fields */ }
Expand description

Fluent wrapper around a KpType (key path) and a set of validation functions.

R is the root type you pass to RuleBuilder::with_root; V is the value type at the end of the path (often String). E is your error payload (e.g. String).

Rule functions must be fn pointers (not closures that capture state) so they can be stored in a Vec and shared across Rayon threads.

Implementations§

Source§

impl<'a, R, V, E> RuleBuilder<'a, R, V, E>
where E: Debug + Clone + 'static + PartialEq + Eq + Send + Sync, R: Sync, V: Sync,

Source

pub fn new(kp: KpType<'a, R, V>) -> Self

Starts a builder for the given statically dispatched key path (#[derive(Kp)] fields).

Source

pub fn with_root(self, root: &'a R) -> Self

Supply the struct instance root that the key path reads from.

Source

pub fn rule(self, f: fn(Option<&'a V>) -> RuleBuilderError<E>) -> Self

Append a rule executed in parallel with other non-mandatory rules when you call apply.

Source

pub fn mandatory_rule(self, f: fn(Option<&'a V>) -> RuleBuilderError<E>) -> Self

Rule that runs before parallel rules, in order. On the first non-Success, apply returns immediately with that single outcome.

Source

pub fn madatory_rule(self, f: fn(Option<&'a V>) -> RuleBuilderError<E>) -> Self

👎Deprecated:

use mandatory_rule

Deprecated typo; use Self::mandatory_rule.

Source

pub fn apply(&self) -> Vec<RuleBuilderError<E>>

Resolves Option<&V> via the key path, runs mandatory rules, then runs remaining rules on a Rayon thread pool.

Auto Trait Implementations§

§

impl<'a, R, V, E> Freeze for RuleBuilder<'a, R, V, E>

§

impl<'a, R, V, E> RefUnwindSafe for RuleBuilder<'a, R, V, E>

§

impl<'a, R, V, E> Send for RuleBuilder<'a, R, V, E>
where R: Sync,

§

impl<'a, R, V, E> Sync for RuleBuilder<'a, R, V, E>
where R: Sync,

§

impl<'a, R, V, E> Unpin for RuleBuilder<'a, R, V, E>
where R: Unpin, V: Unpin,

§

impl<'a, R, V, E> UnsafeUnpin for RuleBuilder<'a, R, V, E>

§

impl<'a, R, V, E> !UnwindSafe for RuleBuilder<'a, R, V, E>

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,