Struct ParamSet 

pub struct ParamSet {
    pub specs: Vec<ParamSpec>,
    pub values: BTreeMap<String, Value>,
}

A set of parameter descriptions and their current values.

Fields

specs: Vec<ParamSpec>

Descriptions in declaration order.

values: BTreeMap<String, Value>

Current values; missing entries use the default.

Implementations

impl ParamSet

pub fn new() -> Self

Creates an empty set.

pub fn with_param(self, spec: ParamSpec) -> Result<Self, Error>

Adds a specification and its default value.

Errors

Returns Error::InvalidInput for a duplicate name or a default that violates the specification.

pub fn set(&mut self, name: &str, value: Value) -> Result<(), Error>

Sets a value after validation.

Errors

Returns Error::InvalidInput for an unknown parameter or an invalid value.

pub fn get(&self, name: &str) -> Option<&Value>

Gets a value.

pub fn check_required(&self) -> Result<(), Error>

Checks that every required parameter has a value.

Errors

Returns Error::InvalidInput naming the missing parameter.

pub fn schema(&self) -> Value

A JSON schema-like object for the agent layer.

impl ParamSet

pub fn to_json(&self) -> Result<String, Error>

Serializes the descriptions and current values.

Errors

Returns Error::InvalidInput when serialization fails.

pub fn from_json(text: &str) -> Result<Self, Error>

Parses a stored parameter set and validates every value.

Errors

Returns Error::InvalidInput for invalid JSON, unknown fields or a value that violates its specification.

Trait Implementations

impl Clone for ParamSet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamSet

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

Formats the value using the given formatter.

impl Default for ParamSet

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ParamSet

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ParamSet

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ParamSet

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 ParamSet