Struct SchemaDefinition

pub struct SchemaDefinition {
    pub data_type: SchemaDataType,
    pub constraints: Vec<SchemaConstraint>,
    pub description: Option<String>,
    pub default: Option<Value>,
    pub optional: bool,
}

Schema definition for data validation

Fields

data_type: SchemaDataType

Type of the data

constraints: Vec<SchemaConstraint>

Constraints to apply

description: Option<String>

Human-readable description

default: Option<Value>

Default value if not provided

optional: bool

Whether this field is optional

Implementations

impl SchemaDefinition

pub fn new(data_type: SchemaDataType) -> Self

Create a new schema definition

pub fn with_constraint(self, constraint: SchemaConstraint) -> Self

Add a constraint to the schema

pub fn with_constraints(self, constraints: Vec<SchemaConstraint>) -> Self

Add multiple constraints to the schema

pub fn with_description<S: Into<String>>(self, description: S) -> Self

Set description for the schema

pub fn with_default(self, default: Value) -> Self

Set default value for the schema

pub fn optional(self) -> Self

Mark the schema as optional

pub fn required(self) -> Self

Mark the schema as required

Trait Implementations

impl Clone for SchemaDefinition

fn clone(&self) -> SchemaDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SchemaDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SchemaDefinition

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

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

const 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 Serialize for SchemaDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SchemaDefinition