Struct TaggedUnionSchema 

pub struct TaggedUnionSchema {
    pub discriminator: String,
    pub mapping: HashMap<String, Box<dyn Serializable>>,
    pub metadata: Option<MetadataSchema>,
    pub transformations: Vec<EnumTransformation>,
}

Represents a schema for a tagged union in an Arri schema.

This struct defines the discriminator, mapping of variants, optional metadata, and transformations associated with a tagged union.

Fields

discriminator: String

The discriminator used to identify the variant in the tagged union.

mapping: HashMap<String, Box<dyn Serializable>>

A mapping of variant names to their corresponding serializable content.

metadata: Option<MetadataSchema>

Optional metadata associated with the tagged union schema.

transformations: Vec<EnumTransformation>

A list of transformations applied to the variant names.

Implementations

impl TaggedUnionSchema

pub fn new() -> TaggedUnionSchema

Creates a new TaggedUnionSchema instance with default values.

Returns

A new TaggedUnionSchema instance.

pub fn add_mapping( &mut self, variant: impl ToString, content: Box<dyn Serializable>, )

Adds a mapping for a variant in the tagged union.

Arguments

• variant - The name of the variant.
• content - The serializable content associated with the variant.

pub fn set_transforms(&mut self, transformations: &[EnumTransformation])

Sets the transformations to be applied to variant names.

Arguments

• transformations - A slice of EnumTransformation objects.

pub fn set_discriminator(&mut self, discriminator: impl ToString)

Sets the discriminator for the tagged union.

Arguments

• discriminator - The discriminator value as a string.

Trait Implementations

impl Debug for TaggedUnionSchema

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

Formats the value using the given formatter.

impl Default for TaggedUnionSchema

fn default() -> TaggedUnionSchema

Returns the “default value” for a type.

impl PartialEq for TaggedUnionSchema

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serializable for TaggedUnionSchema

fn serialize(&self) -> Option<String>

Serializes the object into an optional string representation.

fn set_metadata(&mut self, metadata: MetadataSchema)

Sets metadata for the object.

fn set_nullable(&mut self, nullable: bool)

Sets the nullability of the object.

fn set_rename(&mut self, new_name: &str)

Renames the object.

impl Eq for TaggedUnionSchema

impl StructuralPartialEq for TaggedUnionSchema