Struct ASKit 

pub struct ASKit { /* private fields */ }

Implementations

impl ASKit

pub fn new() -> Self

pub fn init() -> Result<Self, AgentError>

Initialize ASKit.

pub async fn ready(&self) -> Result<(), AgentError>

Prepare ASKit to be ready.

pub fn quit(&self)

Quit ASKit.

pub fn register_agent_definiton(&self, def: AgentDefinition)

Register an agent definition.

pub fn get_agent_definitions(&self) -> AgentDefinitions

Get all agent definitions.

pub fn get_agent_definition(&self, def_name: &str) -> Option<AgentDefinition>

Get an agent definition by name.

pub fn get_agent_config_specs(&self, def_name: &str) -> Option<AgentConfigSpecs>

Get the config specs of an agent definition by name.

pub async fn get_agent_spec(&self, agent_id: &str) -> Option<AgentSpec>

Get the agent spec by id.

pub async fn update_agent_spec( &self, agent_id: &str, value: &Value, ) -> Result<(), AgentError>

Update the agent spec by id.

pub fn get_agent_stream_info(&self, id: &str) -> Option<AgentStreamInfo>

Get info of the agent stream by id.

pub fn get_agent_stream_infos(&self) -> Vec<AgentStreamInfo>

Get infos of all agent streams.

pub async fn get_agent_stream_spec(&self, id: &str) -> Option<AgentStreamSpec>

Get the agent stream spec by id.

pub fn update_agent_stream_spec( &self, id: &str, value: &Value, ) -> Result<(), AgentError>

Update the agent stream spec

pub fn new_agent_stream(&self, name: &str) -> Result<String, AgentError>

Create a new agent stream with the given name. If the name already exists, a unique name will be generated by appending a number suffix. Returns the id of the new agent stream.

pub fn rename_agent_stream( &self, id: &str, new_name: &str, ) -> Result<String, AgentError>

Rename an existing agent stream.

pub fn unique_stream_name(&self, name: &str) -> String

Generate a unique stream name by appending a number suffix if needed.

pub fn add_agent_stream( &self, name: String, spec: AgentStreamSpec, ) -> Result<String, AgentError>

Add a new agent stream with the given name and spec, and returns the id of the new agent stream.

The ids of the given spec, including agents and channels, are changed to new unique ids.

pub async fn remove_agent_stream(&self, id: &str) -> Result<(), AgentError>

Remove an agent stream by id.

pub async fn start_agent_stream(&self, id: &str) -> Result<(), AgentError>

Start an agent stream by id.

pub async fn stop_agent_stream(&self, id: &str) -> Result<(), AgentError>

Stop an agent stream by id.

pub fn new_agent_spec(&self, def_name: &str) -> Result<AgentSpec, AgentError>

Create a new agent spec from the given agent definition name.

pub fn add_agent( &self, stream_id: String, spec: AgentSpec, ) -> Result<String, AgentError>

Add an agent to the specified stream, and returns the id of the newly added agent.

pub fn get_agent( &self, agent_id: &str, ) -> Option<Arc<AsyncMutex<Box<dyn Agent>>>>

Get the agent by id.

pub fn add_channel( &self, stream_id: &str, channel: ChannelSpec, ) -> Result<(), AgentError>

Add a channel to the specified stream.

pub fn add_agents_and_channels( &self, stream_id: &str, agents: &Vec<AgentSpec>, channels: &Vec<ChannelSpec>, ) -> Result<(Vec<AgentSpec>, Vec<ChannelSpec>), AgentError>

Add agents and channels to the specified stream.

The ids of the given agents and channels are changed to new unique ids. The agents are not started automatically, even if the stream is running.

pub async fn remove_agent( &self, stream_id: &str, agent_id: &str, ) -> Result<(), AgentError>

Remove an agent from the specified stream.

If the agent is running, it will be stopped first.

pub fn remove_channel( &self, stream_id: &str, channel: &ChannelSpec, ) -> Result<(), AgentError>

Remove a channel from the specified stream.

pub async fn start_agent(&self, agent_id: &str) -> Result<(), AgentError>

Start an agent by id.

pub async fn stop_agent(&self, agent_id: &str) -> Result<(), AgentError>

Stop an agent by id.

pub async fn set_agent_configs( &self, agent_id: String, configs: AgentConfigs, ) -> Result<(), AgentError>

Set configs for an agent by id.

pub fn get_global_configs(&self, def_name: &str) -> Option<AgentConfigs>

Get global configs for the agent definition by name.

pub fn set_global_configs(&self, def_name: String, configs: AgentConfigs)

Set global configs for the agent definition by name.

pub fn get_global_configs_map(&self) -> AgentConfigsMap

Get the global configs map.

pub fn set_global_configs_map(&self, new_configs_map: AgentConfigsMap)

Set the global configs map.

pub async fn send_agent_out( &self, agent_id: String, ctx: AgentContext, pin: String, value: AgentValue, ) -> Result<(), AgentError>

Send output from an agent. (Async version)

pub fn try_send_agent_out( &self, agent_id: String, ctx: AgentContext, pin: String, value: AgentValue, ) -> Result<(), AgentError>

Send output from an agent.

pub async fn write_board_value( &self, name: String, value: AgentValue, ) -> Result<(), AgentError>

Write a value to the board.

pub async fn write_var_value( &self, stream_id: &str, name: &str, value: AgentValue, ) -> Result<(), AgentError>

Write a value to the variable board.

pub fn subscribe(&self) -> Receiver<ASKitEvent>

Subscribe to all ASKit events.

pub fn subscribe_to_event<F, T>(&self, filter_map: F) -> UnboundedReceiver<T>

where F: FnMut(ASKitEvent) -> Option<T> + Send + 'static, T: Send + 'static,

Subscribe to a specific type of ASKitEvent.

It takes a closure that filters and maps the events, and returns an mpsc::UnboundedReceiver that will receive only the successfully mapped events.

Trait Implementations

impl Clone for ASKit

fn clone(&self) -> ASKit

Returns a duplicate of the value.

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

Performs copy-assignment from source.