Struct AttributeSchema 

pub struct AttributeSchema { /* private fields */ }

Defines the expected attributes for a command handler

Implementations

impl AttributeSchema

pub fn new(name: &str) -> Self

Creates a new schema for a command

pub fn add_required(&mut self, name: &str, description: &str) -> &mut Self

Adds a required attribute

pub fn add_optional(&mut self, name: &str, description: &str) -> &mut Self

Adds an optional attribute

pub fn add_optional_with_default( &mut self, name: &str, description: &str, default: AttributeValue, ) -> &mut Self

Adds an optional attribute with a default value

pub fn validate( &self, attributes: &HashMap<String, AttributeValue>, ) -> Result<(), CommandError>

Validates a set of attributes against this schema

pub fn apply_defaults(&self, attributes: &mut HashMap<String, AttributeValue>)

Applies defaults to a set of attributes

pub fn name(&self) -> &str

Gets the name of this schema

pub fn required(&self) -> &HashMap<String, String>

Gets the required attributes

pub fn optional(&self) -> &HashMap<String, String>

Gets the optional attributes

pub fn defaults(&self) -> &HashMap<String, AttributeValue>

Gets the default values

Trait Implementations

impl Clone for AttributeSchema

fn clone(&self) -> AttributeSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AttributeSchema

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

Formats the value using the given formatter.