Struct valico::json_dsl::Builder

source ·
pub struct Builder { /* private fields */ }

Implementations§

source§

impl Builder

source

pub fn new() -> Builder

source

pub fn build<F>(rules: F) -> Builderwhere F: FnOnce(&mut Builder),

Examples found in repository?
examples/example01.rs (lines 5-10)
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
fn main() {
    let params = json_dsl::Builder::build(|params| {
        params.req_nested("user", json_dsl::array(), |params| {
            params.req_typed("name", json_dsl::string());
            params.req_typed("friend_ids", json_dsl::array_of(json_dsl::u64()))
        });
    });

    let mut obj = from_str(r#"{"user": {"name": "Frodo", "friend_ids": ["1223"]}}"#).unwrap();

    let state = params.process(&mut obj, None);
    if state.is_valid() {
        println!("Result object is {}", to_string_pretty(&obj).unwrap());
    } else {
        panic!("Errors during process: {:?}", state);
    }
}
source

pub fn get_required(&self) -> &Vec<Param>

source

pub fn get_optional(&self) -> &Vec<Param>

source

pub fn get_validators(&self) -> &Validators

source

pub fn req_defined(&mut self, name: &str)

source

pub fn req_typed(&mut self, name: &str, coercer: Box<dyn Coercer + Send + Sync>)

Examples found in repository?
examples/example01.rs (line 7)
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
fn main() {
    let params = json_dsl::Builder::build(|params| {
        params.req_nested("user", json_dsl::array(), |params| {
            params.req_typed("name", json_dsl::string());
            params.req_typed("friend_ids", json_dsl::array_of(json_dsl::u64()))
        });
    });

    let mut obj = from_str(r#"{"user": {"name": "Frodo", "friend_ids": ["1223"]}}"#).unwrap();

    let state = params.process(&mut obj, None);
    if state.is_valid() {
        println!("Result object is {}", to_string_pretty(&obj).unwrap());
    } else {
        panic!("Errors during process: {:?}", state);
    }
}
source

pub fn req_nested<F>( &mut self, name: &str, coercer: Box<dyn Coercer + Send + Sync>, nest_def: F )where F: FnOnce(&mut Builder),

Examples found in repository?
examples/example01.rs (lines 6-9)
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
fn main() {
    let params = json_dsl::Builder::build(|params| {
        params.req_nested("user", json_dsl::array(), |params| {
            params.req_typed("name", json_dsl::string());
            params.req_typed("friend_ids", json_dsl::array_of(json_dsl::u64()))
        });
    });

    let mut obj = from_str(r#"{"user": {"name": "Frodo", "friend_ids": ["1223"]}}"#).unwrap();

    let state = params.process(&mut obj, None);
    if state.is_valid() {
        println!("Result object is {}", to_string_pretty(&obj).unwrap());
    } else {
        panic!("Errors during process: {:?}", state);
    }
}
source

pub fn req<F>(&mut self, name: &str, param_builder: F)where F: FnOnce(&mut Param),

source

pub fn opt_defined(&mut self, name: &str)

source

pub fn opt_typed(&mut self, name: &str, coercer: Box<dyn Coercer + Send + Sync>)

source

pub fn opt_nested<F>( &mut self, name: &str, coercer: Box<dyn Coercer + Send + Sync>, nest_def: F )where F: FnOnce(&mut Builder),

source

pub fn opt<F>(&mut self, name: &str, param_builder: F)where F: FnOnce(&mut Param),

source

pub fn validate( &mut self, validator: Box<dyn Validator + Send + Sync + 'static> )

source

pub fn validate_with<F>(&mut self, validator: F)where F: Fn(&Value, &str) -> ValidatorResult + 'static + Send + Sync,

source

pub fn mutually_exclusive(&mut self, params: &[&str])

source

pub fn exactly_one_of(&mut self, params: &[&str])

source

pub fn at_least_one_of(&mut self, params: &[&str])

source

pub fn schema_id(&mut self, id: Url)

source

pub fn schema<F>(&mut self, build: F)where F: Fn(&mut Builder) + 'static + Send + Sync,

source

pub fn build_schemes(&mut self, scope: &mut Scope) -> Result<(), SchemaError>

source

pub fn process(&self, val: &mut Value, scope: Option<&Scope>) -> ValidationState

Examples found in repository?
examples/example01.rs (line 14)
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
fn main() {
    let params = json_dsl::Builder::build(|params| {
        params.req_nested("user", json_dsl::array(), |params| {
            params.req_typed("name", json_dsl::string());
            params.req_typed("friend_ids", json_dsl::array_of(json_dsl::u64()))
        });
    });

    let mut obj = from_str(r#"{"user": {"name": "Frodo", "friend_ids": ["1223"]}}"#).unwrap();

    let state = params.process(&mut obj, None);
    if state.is_valid() {
        println!("Result object is {}", to_string_pretty(&obj).unwrap());
    } else {
        panic!("Errors during process: {:?}", state);
    }
}
source

pub fn process_nest( &self, val: &mut Value, path: &str, scope: Option<&Scope> ) -> ValidationState

Trait Implementations§

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast for Twhere T: Any,

source§

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.