Struct ZDiscriminatedUnion 

pub struct ZDiscriminatedUnion { /* private fields */ }

Discriminated union: chooses a schema based on a discriminator field value.

More efficient than a regular union because it looks up the correct variant by the discriminator field value instead of trying each schema in order.

Created via vld::discriminated_union().

Example

let schema = vld::discriminated_union("type")
    .variant("dog", vld::object().field("type", vld::literal("dog")).field("bark", vld::boolean()))
    .variant("cat", vld::object().field("type", vld::literal("cat")).field("lives", vld::number().int()));

Implementations

impl ZDiscriminatedUnion

pub fn new(discriminator: impl Into<String>) -> ZDiscriminatedUnion

pub fn variant<S>( self, value: impl Into<Value>, schema: S, ) -> ZDiscriminatedUnion

where S: DynSchema + 'static,

Add a variant: when the discriminator field equals value, use schema.

pub fn variant_str<S>(self, value: &str, schema: S) -> ZDiscriminatedUnion

where S: DynSchema + 'static,

Add a string variant (convenience).

Trait Implementations

impl VldSchema for ZDiscriminatedUnion

type Output = Value

The Rust type produced by this schema after successful parsing.

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

Parse and validate a serde_json::Value.

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

where I: VldInput + ?Sized,

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

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

where T: Serialize,

Validate an existing Rust value against this schema.

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

where T: Serialize,

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 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 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>(self, next: S) -> ZPipe<Self, S>

where S: VldSchema, 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>(self, other: B) -> ZUnion2<Self, B>

where B: VldSchema,

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

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

where B: VldSchema,

Create an intersection: input must satisfy both schemas.

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

Override the error message for this schema.