Struct AgentFile 

pub struct AgentFile {
    pub config: Option<Spanned<ConfigBlock>>,
    pub variables: Option<Spanned<VariablesBlock>>,
    pub system: Option<Spanned<SystemBlock>>,
    pub connections: Vec<Spanned<ConnectionBlock>>,
    pub knowledge: Option<Spanned<KnowledgeBlock>>,
    pub language: Option<Spanned<LanguageBlock>>,
    pub start_agent: Option<Spanned<StartAgentBlock>>,
    pub topics: Vec<Spanned<TopicBlock>>,
}

A complete parsed AgentScript file.

This is the root type returned by crate::parse(). It contains all the top-level blocks that make up an AgentScript definition.

Structure

An AgentScript file typically contains:

• config: - Required agent metadata
• system: - Global instructions and messages
• variables: - State variables
• start_agent: - Entry point for the agent
• One or more topic: blocks - Conversation topics

Example

use busbar_sf_agentscript::parse;

let source = r#"
config:
   agent_name: "MyAgent"

topic main:
   description: "Main topic"
"#;

let agent = parse(source).unwrap();
assert!(agent.config.is_some());
assert_eq!(agent.topics.len(), 1);

Fields

config: Option<Spanned<ConfigBlock>>

Agent configuration block (config: section).

Contains agent metadata like name, label, and description. Should be the first block in the file.

variables: Option<Spanned<VariablesBlock>>

Variable declarations (variables: section).

Defines state variables that can be mutable (read-write) or linked (read-only from external context).

system: Option<Spanned<SystemBlock>>

System configuration (system: section).

Contains global instructions and system messages like welcome and error messages.

connections: Vec<Spanned<ConnectionBlock>>

Connection configurations (connection <name>: blocks).

Each connection block defines escalation routing for a specific channel. Multiple connection blocks can exist at the top level.

knowledge: Option<Spanned<KnowledgeBlock>>

Knowledge base configuration (knowledge: section).

Configures access to external knowledge sources.

language: Option<Spanned<LanguageBlock>>

Language/locale settings (language: section).

Configures internationalization settings.

start_agent: Option<Spanned<StartAgentBlock>>

Entry point (start_agent: section).

The initial topic selector that routes conversations to appropriate topics.

topics: Vec<Spanned<TopicBlock>>

Conversation topics (topic: sections).

Each topic defines a conversational context with its own reasoning instructions and available actions.

Implementations

impl AgentFile

pub fn new() -> Self

Create a new empty AgentFile.

Example

use busbar_sf_agentscript::AgentFile;

let agent = AgentFile::new();
assert!(agent.config.is_none());
assert!(agent.topics.is_empty());

Trait Implementations

impl Clone for AgentFile

fn clone(&self) -> AgentFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentFile

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

Formats the value using the given formatter.

impl Default for AgentFile

fn default() -> AgentFile

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AgentFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AgentFile

fn eq(&self, other: &AgentFile) -> 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 AgentFile

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 AgentFile