Struct ZJsonValue 

pub struct ZJsonValue { /* private fields */ }

Schema for any JSON value, with optional shape checks. Built with vld::json_value().

Implementations

impl ZJsonValue

pub fn new() -> Self

Create the schema (the same as its vld:: constructor function).

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

Set a custom error message for type mismatch (object() / array() / require_key on a non-object).

pub fn object(self) -> Self

Must be a JSON object.

pub fn array(self) -> Self

Must be a JSON array.

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

Must be an object containing key.

pub fn max_depth(self, depth: usize) -> Self

Nesting must not be deeper than depth.

Trait Implementations

impl Clone for ZJsonValue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CollectNestedSchemas for ZJsonValue

Available on crate feature openapi only.

fn collect_nested_schemas(&self, _out: &mut Vec<NestedSchemaEntry>)

Add the named schemas this schema references to _out (for components.schemas).

impl Default for ZJsonValue

fn default() -> Self

Returns the “default value” for a type.

impl JsonSchema for ZJsonValue

Available on crate feature openapi only.

fn is_required(&self) -> bool

Required only when null is rejected (object / array / required keys).

fn json_schema(&self) -> Value

Generate a JSON Schema representation.

impl VldSchema for ZJsonValue

type Output = Value

The Rust type produced by this schema after successful parsing.

fn parse_value(&self, value: &Value) -> Result<Self::Output, VldError>

Parse and validate a serde_json::Value.

fn parse_missing(&self) -> Result<Self::Output, VldError>

Parse an object field whose key is absent.

fn parse<I: VldInput + ?Sized>( &self, input: &I, ) -> Result<Self::Output, VldError>

Parse from any supported input (JSON string, file path, serde_json::Value, etc.)

fn validate<T: Serialize>(&self, value: &T) -> Result<Self::Output, VldError>

Validate an existing Rust value against this schema.

fn is_valid<T: Serialize>(&self, value: &T) -> bool

Check if an existing Rust value passes this schema’s validation.

fn optional(self) -> ZOptional<Self>

Make this field optional. Missing or null values become None.

fn nullable(self) -> ZNullable<Self>

Allow null values. Null becomes None.

fn with_default(self, value: Self::Output) -> ZDefault<Self>

where Self::Output: Clone,

Provide a default value when the field is missing or null.

fn blank_as(self, value: Self::Output) -> ZDefault<Self>

where Self::Output: Clone,

Like with_default, and a blank string (empty or whitespace only) also becomes value: legacy stores that write "" or null for “unset”.

fn refine<F>(self, check: F, message: &str) -> ZRefine<Self, F>

where F: Fn(&Self::Output) -> bool,

Add a custom refinement check without changing the output type.

fn rule<R>(self, rule: R) -> ZRule<Self, R>

where Self: Sized, R: Rule<Self::Output>,

Check the output with a reusable Rule (output type unchanged).

fn rule_msg<R>(self, rule: R, msg: impl Into<String>) -> ZRule<Self, R>

where Self: Sized, R: Rule<Self::Output>,

rule with a custom error message.

fn try_transform<F, U, E>(self, f: F) -> ZTryTransform<Self, F, U>

where F: Fn(Self::Output) -> Result<U, E>, E: Display,

Transform the output with a fallible function; an Err becomes a validation issue (Custom { code: "transform" }, message = the error).

fn transform<F, U>(self, f: F) -> ZTransform<Self, F, U>

where F: Fn(Self::Output) -> U,

Transform the output value after successful parsing.

fn nullish(self) -> ZNullish<Self>

Make this field nullish (both optional and nullable).

fn catch(self, fallback: Self::Output) -> ZCatch<Self>

where Self::Output: Clone,

Return a fallback value on ANY validation error.

fn pipe<S: VldSchema>(self, next: S) -> ZPipe<Self, S>

where Self::Output: Serialize,

Chain this schema’s output into another schema.

fn describe(self, description: &str) -> ZDescribe<Self>

Attach a human-readable description/label to this schema.

fn super_refine<F>(self, check: F) -> ZSuperRefine<Self, F>

where F: Fn(&Self::Output, &mut VldError),

Add a custom refinement that can produce multiple errors.

fn or<B: VldSchema>(self, other: B) -> ZUnion2<Self, B>

Create a union: this schema or another. Returns Either<Self::Output, B::Output>.

fn and<B: VldSchema>(self, other: B) -> ZIntersection<Self, B>

Create an intersection: input must satisfy both schemas.

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

Override the error message for this schema.