Enum AgentValue 

pub enum AgentValue {
    Unit,
    Boolean(bool),
    Integer(i64),
    Number(f64),
    String(Arc<String>),
    Image(Arc<PhotonImage>),
    Array(Vector<AgentValue>),
    Object(HashMap<String, AgentValue>),
    Tensor(Arc<Vec<f32>>),
    Message(Arc<Message>),
    Error(Arc<AgentError>),
}

The value type passed between agents.

Supports multiple data types with immutable data structures for efficient cloning. Large data (String, Image, Tensor, etc.) is wrapped in Arc for reference-counted sharing.

Variants

Unit

Empty value. Used as a trigger signal.

Boolean(bool)

Boolean value.

Integer(i64)

64-bit signed integer.

Number(f64)

64-bit floating point number.

String(Arc<String>)

UTF-8 string wrapped in Arc for efficient cloning.

Image(Arc<PhotonImage>)

Image data (requires image feature).

Array(Vector<AgentValue>)

Ordered array of values.

Object(HashMap<String, AgentValue>)

Key-value map.

Tensor(Arc<Vec<f32>>)

Tensor data for embeddings, etc.

Message(Arc<Message>)

LLM chat message.

Error(Arc<AgentError>)

Error value for propagating errors through the workflow.

Implementations

impl AgentValue

pub fn unit() -> Self

Creates a Unit value.

pub fn boolean(value: bool) -> Self

Creates a Boolean value.

pub fn integer(value: i64) -> Self

Creates an Integer value.

pub fn number(value: f64) -> Self

Creates a Number value.

pub fn string(value: impl Into<String>) -> Self

Creates a String value.

pub fn image(value: PhotonImage) -> Self

Creates an Image value from a PhotonImage.

pub fn image_arc(value: Arc<PhotonImage>) -> Self

Creates an Image value from an Arc<PhotonImage>.

pub fn array(value: Vector<AgentValue>) -> Self

Creates an Array value.

pub fn object(value: AgentValueMap<String, AgentValue>) -> Self

Creates an Object value.

pub fn tensor(value: Vec<f32>) -> Self

Creates a Tensor value from a Vec<f32>.

pub fn message(value: Message) -> Self

Creates a Message value.

pub fn boolean_default() -> Self

Creates a default Boolean value (false).

pub fn integer_default() -> Self

Creates a default Integer value (0).

pub fn number_default() -> Self

Creates a default Number value (0.0).

pub fn string_default() -> Self

Creates a default String value (empty string).

pub fn image_default() -> Self

Creates a default Image value (1x1 transparent pixel).

pub fn array_default() -> Self

Creates a default Array value (empty array).

pub fn object_default() -> Self

Creates a default Object value (empty object).

pub fn tensor_default() -> Self

Creates a default Tensor value (empty vector).

pub fn from_json(value: Value) -> Result<Self, AgentError>

Creates an AgentValue from a serde_json::Value.

Errors

Returns InvalidValue if the JSON value cannot be converted.

pub fn to_json(&self) -> Value

Converts to a serde_json::Value.

pub fn from_serialize<T: Serialize>(value: &T) -> Result<Self, AgentError>

Create AgentValue from Serialize

pub fn to_deserialize<T: for<'de> Deserialize<'de>>( &self, ) -> Result<T, AgentError>

Convert AgentValue to a Deserialize

pub fn is_unit(&self) -> bool

Returns true if this is a Unit value.

pub fn is_boolean(&self) -> bool

Returns true if this is a Boolean value.

pub fn is_integer(&self) -> bool

Returns true if this is an Integer value.

pub fn is_number(&self) -> bool

Returns true if this is a Number value.

pub fn is_string(&self) -> bool

Returns true if this is a String value.

pub fn is_image(&self) -> bool

Returns true if this is an Image value.

pub fn is_array(&self) -> bool

Returns true if this is an Array value.

pub fn is_object(&self) -> bool

Returns true if this is an Object value.

pub fn is_tensor(&self) -> bool

Returns true if this is a Tensor value.

pub fn is_message(&self) -> bool

Returns true if this is a Message value.

pub fn as_bool(&self) -> Option<bool>

Returns the inner boolean value if this is a Boolean, otherwise None.

pub fn as_i64(&self) -> Option<i64>

Returns the value as i64 if this is an Integer or Number, otherwise None.

pub fn as_f64(&self) -> Option<f64>

Returns the value as f64 if this is an Integer or Number, otherwise None.

pub fn as_str(&self) -> Option<&str>

Returns a reference to the inner string if this is a String, otherwise None.

pub fn as_image(&self) -> Option<&PhotonImage>

Returns a reference to the inner image if this is an Image, otherwise None.

pub fn as_image_mut(&mut self) -> Option<&mut PhotonImage>

Returns a mutable reference to the inner image if this is an Image, otherwise None.

pub fn into_image(self) -> Option<Arc<PhotonImage>>

Extracts the inner Arc<PhotonImage> if this is an Image, consuming self.

pub fn as_message(&self) -> Option<&Message>

Returns a reference to the inner message if this is a Message, otherwise None.

pub fn as_message_mut(&mut self) -> Option<&mut Message>

Returns a mutable reference to the inner message if this is a Message, otherwise None.

pub fn into_message(self) -> Option<Arc<Message>>

Extracts the inner Arc<Message> if this is a Message, consuming self.

pub fn to_boolean(&self) -> Option<bool>

Converts to a boolean with type coercion.

Conversion rules:

• Boolean: returns the value
• Integer: 0 → false, otherwise true
• Number: 0.0 → false, otherwise true
• String: parses “true”/“false”

pub fn to_boolean_value(&self) -> Option<AgentValue>

Converts to AgentValue::Boolean or AgentValue::Array of booleans.

pub fn to_integer(&self) -> Option<i64>

Converts to an integer (i64) with type coercion.

pub fn to_integer_value(&self) -> Option<AgentValue>

Converts to AgentValue::Integer or AgentValue::Array of integers.

pub fn to_number(&self) -> Option<f64>

Converts to a number (f64) with type coercion.

pub fn to_number_value(&self) -> Option<AgentValue>

Converts to AgentValue::Number or AgentValue::Array of numbers.

pub fn to_string(&self) -> Option<String>

Converts to a string with type coercion.

pub fn to_string_value(&self) -> Option<AgentValue>

Converts to AgentValue::String or AgentValue::Array of strings.

pub fn to_message(&self) -> Option<Message>

Converts to a Message.

pub fn to_message_value(&self) -> Option<AgentValue>

Converts to AgentValue::Message or AgentValue::Array of messages.

If the value is an array, it recursively converts its elements.

pub fn as_object(&self) -> Option<&AgentValueMap<String, AgentValue>>

Returns a reference to the inner object map if this is an Object, otherwise None.

pub fn as_object_mut( &mut self, ) -> Option<&mut AgentValueMap<String, AgentValue>>

Returns a mutable reference to the inner object map if this is an Object, otherwise None.

pub fn into_object(self) -> Option<AgentValueMap<String, AgentValue>>

Extracts the inner HashMap if this is an Object, consuming self.

pub fn as_array(&self) -> Option<&Vector<AgentValue>>

Returns a reference to the inner array if this is an Array, otherwise None.

pub fn as_array_mut(&mut self) -> Option<&mut Vector<AgentValue>>

Returns a mutable reference to the inner array if this is an Array, otherwise None.

pub fn into_array(self) -> Option<Vector<AgentValue>>

Extracts the inner Vector if this is an Array, consuming self.

pub fn as_tensor(&self) -> Option<&Vec<f32>>

Returns a reference to the inner tensor if this is a Tensor, otherwise None.

pub fn as_tensor_mut(&mut self) -> Option<&mut Vec<f32>>

Returns a mutable reference to the inner tensor if this is a Tensor, otherwise None.

pub fn into_tensor(self) -> Option<Arc<Vec<f32>>>

Extracts the inner Arc<Vec<f32>> if this is a Tensor, consuming self.

pub fn into_tensor_vec(self) -> Option<Vec<f32>>

Extracts the inner Vec<f32> if this is a Tensor, consuming self. Possibly O(n) copy.

pub fn get(&self, key: &str) -> Option<&AgentValue>

Gets a value by key from an Object.

pub fn get_mut(&mut self, key: &str) -> Option<&mut AgentValue>

Gets a mutable reference to a value by key from an Object.

pub fn get_bool(&self, key: &str) -> Option<bool>

Gets a boolean value by key from an Object.

pub fn get_i64(&self, key: &str) -> Option<i64>

Gets an i64 value by key from an Object.

pub fn get_f64(&self, key: &str) -> Option<f64>

Gets an f64 value by key from an Object.

pub fn get_str(&self, key: &str) -> Option<&str>

Gets a string reference by key from an Object.

pub fn get_image(&self, key: &str) -> Option<&PhotonImage>

Gets an image reference by key from an Object.

pub fn get_image_mut(&mut self, key: &str) -> Option<&mut PhotonImage>

Gets a mutable image reference by key from an Object.

pub fn get_object( &self, key: &str, ) -> Option<&AgentValueMap<String, AgentValue>>

Gets an object reference by key from an Object.

pub fn get_object_mut( &mut self, key: &str, ) -> Option<&mut AgentValueMap<String, AgentValue>>

Gets a mutable object reference by key from an Object.

pub fn get_array(&self, key: &str) -> Option<&Vector<AgentValue>>

Gets an array reference by key from an Object.

pub fn get_array_mut(&mut self, key: &str) -> Option<&mut Vector<AgentValue>>

Gets a mutable array reference by key from an Object.

pub fn get_tensor(&self, key: &str) -> Option<&Vec<f32>>

Gets a tensor reference by key from an Object.

pub fn get_tensor_mut(&mut self, key: &str) -> Option<&mut Vec<f32>>

Gets a mutable tensor reference by key from an Object.

pub fn get_message(&self, key: &str) -> Option<&Message>

Gets a message reference by key from an Object.

pub fn get_message_mut(&mut self, key: &str) -> Option<&mut Message>

Gets a mutable message reference by key from an Object.

pub fn set(&mut self, key: String, value: AgentValue) -> Result<(), AgentError>

Sets a value by key in an Object.

Errors

Returns InvalidValue if this is not an Object.

Trait Implementations

impl Clone for AgentValue

fn clone(&self) -> AgentValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentValue

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

Formats the value using the given formatter.

impl Default for AgentValue

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AgentValue

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for AgentValue

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<()> for AgentValue

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<AgentError> for AgentValue

fn from(value: AgentError) -> Self

Converts to this type from the input type.

impl From<Arc<Vec<f32>>> for AgentValue

fn from(value: Arc<Vec<f32>>) -> Self

Converts to this type from the input type.

impl From<HashMap<String, AgentValue>> for AgentValue

fn from(value: HashMap<String, AgentValue>) -> Self

Converts to this type from the input type.

impl From<HashMap<String, AgentValue>> for AgentValue

fn from(value: HashMap<String, AgentValue>) -> Self

Converts to this type from the input type.

impl From<Message> for AgentValue

fn from(msg: Message) -> Self

Converts to this type from the input type.

impl From<Option<AgentValue>> for AgentValue

fn from(value: Option<AgentValue>) -> Self

Converts to this type from the input type.

impl From<String> for AgentValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<ToolInfo> for AgentValue

fn from(info: ToolInfo) -> Self

Converts to this type from the input type.

impl From<Vec<AgentValue>> for AgentValue

fn from(value: Vec<AgentValue>) -> Self

Converts to this type from the input type.

impl From<Vec<Message>> for AgentValue

fn from(msgs: Vec<Message>) -> Self

Converts to this type from the input type.

impl From<Vec<f32>> for AgentValue

fn from(value: Vec<f32>) -> Self

Converts to this type from the input type.

impl From<Vector<AgentValue>> for AgentValue

fn from(value: Vector<AgentValue>) -> Self

Converts to this type from the input type.

impl From<bool> for AgentValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for AgentValue

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for AgentValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i32> for AgentValue

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for AgentValue

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<u64> for AgentValue

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<usize> for AgentValue

fn from(value: usize) -> Self

Converts to this type from the input type.

impl PartialEq for AgentValue

fn eq(&self, other: &Self) -> 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 Serialize for AgentValue

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<AgentValue> for Message

type Error = AgentError

The type returned in the event of a conversion error.

fn try_from(value: AgentValue) -> Result<Self, Self::Error>

Performs the conversion.