Struct PropertiesSchema 

pub struct PropertiesSchema {
    pub properties: HashMap<String, Box<dyn Serializable>>,
    pub optional_properties: HashMap<String, Box<dyn Serializable>>,
    pub is_strict: Option<bool>,
    pub metadata: Option<MetadataSchema>,
    pub is_nullable: Option<bool>,
}

Represents a schema for properties in an Arri schema.

This struct defines the properties, optional properties, and metadata associated with a schema. It also includes flags for strictness and nullability.

Fields

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

A map of required properties, where the key is the property name and the value is a serializable object.

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

A map of optional properties, where the key is the property name and the value is a serializable object.

is_strict: Option<bool>

Indicates whether the schema is strict. If Some(true), the schema enforces strict validation.

metadata: Option<MetadataSchema>

Metadata associated with the schema.

is_nullable: Option<bool>

Indicates whether the schema allows null values. If Some(true), null values are permitted.

Implementations

impl PropertiesSchema

pub fn new() -> PropertiesSchema

Creates a new PropertiesSchema instance with default values.

pub fn set_property( &mut self, key: impl ToString, value: Box<dyn Serializable>, ) -> &mut PropertiesSchema

Adds or updates a required property in the schema.

Arguments

• key - The name of the property.
• value - A serializable object representing the property value.

Returns

A mutable reference to the PropertiesSchema instance.

pub fn set_optional_property( &mut self, key: impl ToString, value: Box<dyn Serializable>, ) -> &mut PropertiesSchema

Adds or updates an optional property in the schema.

Arguments

• key - The name of the property.
• value - A serializable object representing the property value.

Returns

A mutable reference to the PropertiesSchema instance.

pub fn set_strict(&mut self, strict: bool) -> &mut PropertiesSchema

Sets the strictness flag for the schema.

Arguments

• strict - A boolean indicating whether the schema should enforce strict validation.

Returns

A mutable reference to the PropertiesSchema instance.

Trait Implementations

impl Debug for PropertiesSchema

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

Formats the value using the given formatter.

impl Default for PropertiesSchema

fn default() -> PropertiesSchema

Returns the “default value” for a type.

impl PartialEq for PropertiesSchema

fn eq(&self, other: &PropertiesSchema) -> 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 PropertiesSchema

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

Serializes the PropertiesSchema into a string representation.

Returns

An Option<String> containing the serialized schema, or None if serialization fails.

fn set_metadata(&mut self, metadata: MetadataSchema)

Sets the metadata for the schema.

Arguments

• metadata - A MetadataSchema object to be merged with the existing metadata.

fn set_nullable(&mut self, is_nullable: bool)

Sets the nullability flag for the schema.

Arguments

• is_nullable - A boolean indicating whether null values are allowed.

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

Renames the object.

impl Eq for PropertiesSchema

impl StructuralPartialEq for PropertiesSchema