Struct StartupExamples 

pub struct StartupExamples {
    pub llm_mode: Value,
    pub script_mode: Value,
    pub static_mode: Value,
}

Examples showing how to start a protocol with different handler modes

These examples are required for every protocol and are used in:

• Protocol documentation (shown when user requests docs)
• Prompt templates to guide LLM in creating servers/clients

Each example is a complete open_server action JSON that can be directly executed. The examples must be validated by tests.

Fields

llm_mode: Value

Complete open_server action with LLM handler mode Shows how to start the protocol with LLM-controlled responses

script_mode: Value

Complete open_server action with script handler mode Shows event_handlers with script type handlers

static_mode: Value

Complete open_server action with static handler mode Shows event_handlers with static type handlers and predefined actions

Implementations

impl StartupExamples

pub fn new(llm_mode: Value, script_mode: Value, static_mode: Value) -> Self

Create new startup examples

pub fn validate(&self, protocol_name: &str) -> Result<(), String>

Validate that all examples are well-formed open_server actions

Returns Ok(()) if valid, Err with description if invalid. This is called by parameterized tests to ensure examples stay valid.

pub fn to_prompt_text(&self) -> String

Convert examples to prompt text for LLM documentation

Trait Implementations

impl Clone for StartupExamples

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 StartupExamples

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

Formats the value using the given formatter.

impl Serialize for StartupExamples

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.