Enum ModularAgentEvent 

#[non_exhaustive]
pub enum ModularAgentEvent {
    AgentConfigUpdated(String, String, AgentValue),
    AgentError(String, String),
    AgentIn(String, String),
    AgentSpecUpdated(String),
    PresetStructureChanged {
        preset_id: String,
    },
    PresetAdded {
        preset_id: String,
        name: Option<String>,
    },
    PresetRemoved {
        preset_id: String,
        name: Option<String>,
    },
    PresetRenamed {
        preset_id: String,
        old_name: Option<String>,
        new_name: String,
    },
    PresetSaved {
        preset_id: String,
        name: String,
    },
    ExternalOutput(String, AgentValue),
}

Events emitted by ModularAgent during operation.

Subscribe to these events using ModularAgent::subscribe or ModularAgent::subscribe_to_event.

Example

use modular_agent_core::{ModularAgent, ModularAgentEvent};

// Subscribe to all external output events
let mut rx = ma.subscribe_to_event(|envelope| {
    if let ModularAgentEvent::ExternalOutput(name, value) = envelope.event {
        Some((name, value))
    } else {
        None
    }
});

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AgentConfigUpdated(String, String, AgentValue)

An agent’s configuration was updated.

Fields: (agent_id, config_key, new_value)

AgentError(String, String)

An agent encountered an error.

Fields: (agent_id, error_message)

AgentIn(String, String)

An agent received input on a port.

Fields: (agent_id, port_name)

AgentSpecUpdated(String)

An agent’s spec was updated.

Fields: (agent_id)

PresetStructureChanged

A preset’s structure (agents, connections, or non-config spec keys) was changed.

Emitted by ModularAgent::add_agent, ModularAgent::remove_agent, ModularAgent::add_connection, ModularAgent::remove_connection, ModularAgent::add_agents_and_connections, ModularAgent::update_preset_spec, and by ModularAgent::update_agent_spec when the patch contains keys other than configs, so hosts can refresh their view of the preset.

Fields

preset_id: String

PresetAdded

A preset was added.

Emitted whenever a preset is created or loaded (ModularAgent::new_preset, ModularAgent::add_preset, their named variants, and open_preset_from_file).

Fields

preset_id: String

name: Option<String>

PresetRemoved

A preset was removed.

Emitted by ModularAgent::remove_preset after the preset and its agents have been torn down, so hosts can close any view of it.

Fields

preset_id: String

name: Option<String>

PresetRenamed

A preset was renamed.

Emitted by ModularAgent::rename_preset. old_name is None when the preset had no name before.

Fields

preset_id: String

old_name: Option<String>

new_name: String

PresetSaved

A named preset was saved to disk.

Emitted by ModularAgent::save_preset; unnamed presets produce no event.

Fields

preset_id: String

name: String

ExternalOutput(String, AgentValue)

A value was written to an external output channel.

This event is emitted when:

• ModularAgent::write_external_input is called and flows through the network
• An ExternalOutputAgent receives a value

Fields: (channel_name, value)

Trait Implementations

impl Clone for ModularAgentEvent

fn clone(&self) -> ModularAgentEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModularAgentEvent

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

Formats the value using the given formatter.