Skip to main content

Crate codex_extension_api

Crate codex_extension_api 

Source

Structs§

ExtensionData
Typed extension-owned data attached to one host object.
ExtensionRegistry
Immutable typed registry produced after extensions are installed.
ExtensionRegistryBuilder
Mutable registry used while hosts register typed runtime contributions.
JsonToolOutput
NoopExtensionEventSink
Event sink used when the host does not expose extension event emission.
PromptFragment
ResponsesApiTool
ThreadResumeInput
Input supplied when the host resumes an existing thread.
ThreadStartInput
Input supplied when the host starts a runtime for a thread.
ThreadStopInput
Input supplied when the host stops a thread runtime.
ToolCall
ToolFinishInput
Input supplied when the host finishes executing one tool call.
ToolName
Identifies a callable tool, preserving the namespace split when the model provides one.
ToolStartInput
Input supplied when the host starts executing one tool call.
TurnAbortInput
Input supplied when the host aborts a turn.
TurnStartInput
Input supplied when the host starts a turn.
TurnStopInput
Input supplied when the host completes a turn.

Enums§

FunctionCallError
Error returned while executing a model-visible tool invocation.
PromptSlot
ToolCallOutcome
Extension-facing outcome for a finished tool call.
ToolCallSource
Host-visible source for a model tool call.
ToolPayload
Canonical payload shapes accepted by model-visible tool runtimes.
ToolSpec
When serialized as JSON, this produces a valid “Tool” in the OpenAI Responses API.

Traits§

AgentSpawner
Constructor-injected host helper for extensions that need to spawn subagents.
ApprovalReviewContributor
Extension contribution that can claim rendered approval-review prompts.
ConfigContributor
Contributor for host-owned configuration changes.
ContextContributor
Extension contribution that adds prompt fragments during prompt assembly.
ExtensionEventSink
Host-provided fire-and-forget sink for extension-generated events.
ThreadLifecycleContributor
Contributor for host-owned thread lifecycle gates.
TokenUsageContributor
Contributor for token usage checkpoints reported by the model provider.
ToolContributor
Extension contribution that exposes native tools owned by a feature.
ToolExecutor
Shared runtime contract for model-visible tools.
ToolLifecycleContributor
Contributor for host-owned tool lifecycle gates.
ToolOutput
Model-facing output contract returned by executable tool runtimes.
TurnItemContributor
Ordered post-processing contribution for one parsed turn item.
TurnLifecycleContributor
Contributor for host-owned turn lifecycle gates.

Functions§

empty_extension_registry
Creates an empty shared registry for hosts that do not register contributions.
parse_tool_input_schema
Parse the tool input_schema or return an error for invalid schema.

Type Aliases§

AgentSpawnFuture
Future returned by one injected subagent-spawn helper.
ToolLifecycleFuture
Future returned by one tool-lifecycle callback.