Enum RuntimeActionId 

#[repr(u32)]
pub enum RuntimeActionId {
    SendMessage = 0,
    SendUserMessage = 1,
    AppendEntry = 2,
    SetSessionName = 3,
    GetActiveTools = 4,
    SetActiveTools = 5,
    SetModel = 6,
    GetThinkingLevel = 7,
    SetThinkingLevel = 8,
    Compact = 9,
    GetSystemPrompt = 10,
    NewSession = 11,
    Fork = 12,
    NavigateTree = 13,
    SwitchSession = 14,
    Reload = 15,
    GetCliFlag = 16,
    UiDialog = 17,
    SetStatus = 18,
    SetEditorText = 19,
    GetSessionBranch = 20,
    StdioLifecycle = 21,
    UiComponent = 22,
}

Identifier for a host runtime action the plugin may invoke via PluginApi::runtime_action. One slot dispatches all actions; the numeric id crosses the FFI boundary as a u32 and the host validates it with TryFrom<u32> before constructing this enum. Args/results cross as JSON strings.

Variants

SendMessage = 0

SendUserMessage = 1

AppendEntry = 2

SetSessionName = 3

GetActiveTools = 4

SetActiveTools = 5

SetModel = 6

GetThinkingLevel = 7

SetThinkingLevel = 8

Compact = 9

GetSystemPrompt = 10

NewSession = 11

Fork = 12

NavigateTree = 13

SwitchSession = 14

Reload = 15

GetCliFlag = 16

Read a parsed CLI flag by name. Args: {"name":"flag"}; result: {"value": <bool|string|null>}.

UiDialog = 17

Open/poll/cancel a host-provided interactive UI request. The payload is a JSON object with op (open, poll, or cancel) and a unique requestId; hosts without an attached TUI return an explicit error.

SetStatus = 18

Publish a short status string for the host’s UI (TUI footer). Args: {"key":"langfuse","value":"langfuse ✓ (trace sent)"}; an empty/absent value clears that key. Result: {"ok":true,"changed":bool}. Headless hosts accept the write but have nothing to render. Legacy footer text (key, value). Use UiComponent for registered UI.

SetEditorText = 19

Put text into the interactive editor (the prompt input box) instead of sending it. Args: {"text":"...", "mode":"append"|"replace", "autoSendMs": 3000} (omit/0 for manual send only). Result: {"ok":true,"chars":N}. A headless host has no editor and accepts the write without rendering it, mirroring RuntimeActionId::SetStatus.

GetSessionBranch = 20

Return the current session branch entries oldest-first as JSON. Args: {}; result: {"entries":[...]}.

StdioLifecycle = 21

Inspect or finish a plugin-owned stdio server lifecycle. Args: {"op":"status"} or {"op":"finish","exitCode":0}. Only the declaring owner may finish; the host performs normal session shutdown.

UiComponent = 22

Plugin-owned text component lifecycle and content updates.

Trait Implementations

impl Clone for RuntimeActionId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RuntimeActionId

impl Debug for RuntimeActionId

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

Formats the value using the given formatter.

impl Eq for RuntimeActionId

impl From<RuntimeActionId> for u32

fn from(value: RuntimeActionId) -> Self

Converts to this type from the input type.

impl PartialEq for RuntimeActionId

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RuntimeActionId

impl TryFrom<u32> for RuntimeActionId

type Error = UnknownRuntimeActionId

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.