Enum Effect 

pub enum Effect<M = UnitTurnProtocol>
where
    M: TurnProtocol,
{
    SyncExecutionSurface {
        id: EffectId,
        update_machine_config: bool,
    },
    LlmCall {
        id: EffectId,
        request: Arc<LlmRequest>,
    },
    CancelLlm {
        id: EffectId,
    },
    ToolCalls {
        id: EffectId,
        calls: Vec<PendingToolCall>,
    },
    ExecCode {
        id: EffectId,
        code: String,
    },
    Checkpoint {
        id: EffectId,
        checkpoint: CheckpointKind,
    },
    Log {
        event: LogEvent,
    },
    Emit(SessionEvent),
    Progress {
        messages: MessageSequence,
        event_delta: Vec<SessionEventRecord<<M as TurnProtocol>::Event>>,
        protocol_iteration: usize,
    },
    Done {
        messages: MessageSequence,
        event_delta: Vec<SessionEventRecord<<M as TurnProtocol>::Event>>,
        protocol_iteration: usize,
    },
}

An effect the host must fulfil.

Variants

SyncExecutionSurface

Sync the live execution surface before the turn proceeds.

update_machine_config is only needed after the turn has already advanced at least once and the host may need to swap in a refreshed system prompt or tool schema for the next protocol iteration. Initial syncs are host-only because the machine was already constructed from a fresh execution surface.

Fields

id: EffectId

update_machine_config: bool

LlmCall

Start an LLM call.

Fields

id: EffectId

request: Arc<LlmRequest>

CancelLlm

Cancel an in-progress LLM stream.

Fields

id: EffectId

ToolCalls

Execute one or more driver-scheduled tool calls.

Fields

id: EffectId

calls: Vec<PendingToolCall>

ExecCode

Execute a protocol-owned code block.

Fields

id: EffectId

code: String

Checkpoint

Run a host/plugin checkpoint before the machine continues or completes.

Fields

id: EffectId

checkpoint: CheckpointKind

Log

Host-implemented fire-and-forget logging.

Fields

event: LogEvent

Emit(SessionEvent)

Fire-and-forget event (no response needed).

Progress

Prompt-history progress that may be durably persisted by the host.

This is separate from SessionEvent: UI stream events can be partial, duplicated, or display-only, while Progress is emitted only after the state machine has applied semantic message or protocol-step changes.

Fields

messages: MessageSequence

event_delta: Vec<SessionEventRecord<<M as TurnProtocol>::Event>>

protocol_iteration: usize

Done

Turn is done.

Fields

messages: MessageSequence

event_delta: Vec<SessionEventRecord<<M as TurnProtocol>::Event>>

protocol_iteration: usize

Trait Implementations

impl<M> Clone for Effect<M>

where M: TurnProtocol,

fn clone(&self) -> Effect<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Debug for Effect<M>

where M: Debug + TurnProtocol, <M as TurnProtocol>::Event: Debug,

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

Formats the value using the given formatter.

impl<'de, M> Deserialize<'de> for Effect<M>

where M: TurnProtocol,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Effect<M>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<M> Serialize for Effect<M>

where M: TurnProtocol,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.