Enum Notification 

pub enum Notification {
    ThreadStarted(ThreadStartedNotification),
    ThreadStatusChanged(ThreadStatusChangedNotification),
    ThreadTokenUsageUpdated(ThreadTokenUsageUpdatedNotification),
    TurnStarted(TurnStartedNotification),
    TurnCompleted(TurnCompletedNotification),
    ItemStarted(ItemStartedNotification),
    ItemCompleted(ItemCompletedNotification),
    AgentMessageDelta(AgentMessageDeltaNotification),
    CmdOutputDelta(CommandExecutionOutputDeltaNotification),
    FileChangeOutputDelta(FileChangeOutputDeltaNotification),
    ReasoningDelta(ReasoningSummaryTextDeltaNotification),
    Error(ErrorNotification),
    AccountRateLimitsUpdated(AccountRateLimitsUpdatedNotification),
    McpServerStartupStatusUpdated(McpServerStatusUpdatedNotification),
    RemoteControlStatusChanged(RemoteControlStatusChangedNotification),
    McpServerOauthLoginCompleted(McpServerOauthLoginCompletedNotification),
    FileChangePatchUpdated(FileChangePatchUpdatedNotification),
    PlanDelta(PlanDeltaNotification),
    TurnPlanUpdated(TurnPlanUpdatedNotification),
    TurnDiffUpdated(TurnDiffUpdatedNotification),
    ReasoningSummaryPartAdded(ReasoningSummaryPartAddedNotification),
    ReasoningTextDelta(ReasoningTextDeltaNotification),
    AccountLoginCompleted(AccountLoginCompletedNotification),
    DeprecationNotice(DeprecationNoticeNotification),
    GuardianWarning(GuardianWarningNotification),
    Warning(WarningNotification),
    ThreadArchived(ThreadArchivedNotification),
    ThreadClosed(ThreadClosedNotification),
    ThreadDeleted(ThreadDeletedNotification),
    ThreadUnarchived(ThreadUnarchivedNotification),
    ThreadGoalCleared(ThreadGoalClearedNotification),
    ThreadNameUpdated(ThreadNameUpdatedNotification),
    SkillsChanged(SkillsChangedNotification),
    FsChanged(FsChangedNotification),
    ConfigWarning(ConfigWarningNotification),
    AccountUpdated(AccountUpdatedNotification),
    AppListUpdated(AppListUpdatedNotification),
    CommandExecOutputDelta(CommandExecOutputDeltaNotification),
    ExternalAgentConfigImportCompleted(ExternalAgentConfigImportCompletedNotification),
    FuzzyFileSearchSessionCompleted(FuzzyFileSearchSessionCompletedNotification),
    FuzzyFileSearchSessionUpdated(FuzzyFileSearchSessionUpdatedNotification),
    HookCompleted(HookCompletedNotification),
    HookStarted(HookStartedNotification),
    ItemGuardianApprovalReviewCompleted(ItemGuardianApprovalReviewCompletedNotification),
    ItemGuardianApprovalReviewStarted(ItemGuardianApprovalReviewStartedNotification),
    TerminalInteraction(TerminalInteractionNotification),
    McpToolCallProgress(McpToolCallProgressNotification),
    ModelRerouted(ModelReroutedNotification),
    ModelVerification(ModelVerificationNotification),
    ProcessExited(ProcessExitedNotification),
    ProcessOutputDelta(ProcessOutputDeltaNotification),
    ServerRequestResolved(ServerRequestResolvedNotification),
    ContextCompacted(ContextCompactedNotification),
    ThreadGoalUpdated(ThreadGoalUpdatedNotification),
    ThreadRealtimeClosed(ThreadRealtimeClosedNotification),
    ThreadRealtimeError(ThreadRealtimeErrorNotification),
    ThreadRealtimeItemAdded(ThreadRealtimeItemAddedNotification),
    ThreadRealtimeOutputAudioDelta(ThreadRealtimeOutputAudioDeltaNotification),
    ThreadRealtimeSdp(ThreadRealtimeSdpNotification),
    ThreadRealtimeStarted(ThreadRealtimeStartedNotification),
    ThreadRealtimeTranscriptDelta(ThreadRealtimeTranscriptDeltaNotification),
    ThreadRealtimeTranscriptDone(ThreadRealtimeTranscriptDoneNotification),
    WindowsWorldWritableWarning(WindowsWorldWritableWarningNotification),
    WindowsSandboxSetupCompleted(WindowsSandboxSetupCompletedNotification),
    ThreadSettingsUpdated(ThreadSettingsUpdatedNotification),
    TurnModerationMetadata(TurnModerationMetadataNotification),
    ExternalAgentConfigImportProgress(ExternalAgentConfigImportProgressNotification),
    ModelSafetyBufferingUpdated(ModelSafetyBufferingUpdatedNotification),
    ThreadEnvironmentConnected(EnvironmentConnectionNotification),
    ThreadEnvironmentDisconnected(EnvironmentConnectionNotification),
    Unknown {
        method: String,
        params: Option<Value>,
    },
}

A server-to-client notification.

Each variant maps to a single method string on the wire. The Unknown variant captures methods this crate version doesn’t model yet, preserving the raw payload for inspection.

Variants

ThreadStarted(ThreadStartedNotification)

thread/started

ThreadStatusChanged(ThreadStatusChangedNotification)

thread/status/changed

ThreadTokenUsageUpdated(ThreadTokenUsageUpdatedNotification)

thread/tokenUsage/updated

TurnStarted(TurnStartedNotification)

turn/started

TurnCompleted(TurnCompletedNotification)

turn/completed

ItemStarted(ItemStartedNotification)

item/started

ItemCompleted(ItemCompletedNotification)

item/completed

AgentMessageDelta(AgentMessageDeltaNotification)

item/agentMessage/delta

CmdOutputDelta(CommandExecutionOutputDeltaNotification)

item/commandExecution/outputDelta

FileChangeOutputDelta(FileChangeOutputDeltaNotification)

item/fileChange/outputDelta

ReasoningDelta(ReasoningSummaryTextDeltaNotification)

item/reasoning/summaryTextDelta

Error(ErrorNotification)

error

AccountRateLimitsUpdated(AccountRateLimitsUpdatedNotification)

account/rateLimits/updated

McpServerStartupStatusUpdated(McpServerStatusUpdatedNotification)

mcpServer/startupStatus/updated

RemoteControlStatusChanged(RemoteControlStatusChangedNotification)

remoteControl/status/changed

McpServerOauthLoginCompleted(McpServerOauthLoginCompletedNotification)

mcpServer/oauthLogin/completed

FileChangePatchUpdated(FileChangePatchUpdatedNotification)

item/fileChange/patchUpdated

PlanDelta(PlanDeltaNotification)

item/plan/delta (EXPERIMENTAL)

TurnPlanUpdated(TurnPlanUpdatedNotification)

turn/plan/updated

TurnDiffUpdated(TurnDiffUpdatedNotification)

turn/diff/updated

ReasoningSummaryPartAdded(ReasoningSummaryPartAddedNotification)

item/reasoning/summaryPartAdded

ReasoningTextDelta(ReasoningTextDeltaNotification)

item/reasoning/textDelta

AccountLoginCompleted(AccountLoginCompletedNotification)

account/login/completed

DeprecationNotice(DeprecationNoticeNotification)

deprecationNotice

GuardianWarning(GuardianWarningNotification)

guardianWarning

Warning(WarningNotification)

warning

ThreadArchived(ThreadArchivedNotification)

thread/archived

ThreadClosed(ThreadClosedNotification)

thread/closed

ThreadDeleted(ThreadDeletedNotification)

thread/deleted

ThreadUnarchived(ThreadUnarchivedNotification)

thread/unarchived

ThreadGoalCleared(ThreadGoalClearedNotification)

thread/goal/cleared

ThreadNameUpdated(ThreadNameUpdatedNotification)

thread/name/updated

SkillsChanged(SkillsChangedNotification)

skills/changed

FsChanged(FsChangedNotification)

fs/changed

ConfigWarning(ConfigWarningNotification)

configWarning

AccountUpdated(AccountUpdatedNotification)

account/updated

AppListUpdated(AppListUpdatedNotification)

app/list/updated

CommandExecOutputDelta(CommandExecOutputDeltaNotification)

command/exec/outputDelta

ExternalAgentConfigImportCompleted(ExternalAgentConfigImportCompletedNotification)

externalAgentConfig/import/completed

FuzzyFileSearchSessionCompleted(FuzzyFileSearchSessionCompletedNotification)

fuzzyFileSearch/sessionCompleted

FuzzyFileSearchSessionUpdated(FuzzyFileSearchSessionUpdatedNotification)

fuzzyFileSearch/sessionUpdated

HookCompleted(HookCompletedNotification)

hook/completed

HookStarted(HookStartedNotification)

hook/started

ItemGuardianApprovalReviewCompleted(ItemGuardianApprovalReviewCompletedNotification)

item/autoApprovalReview/completed

ItemGuardianApprovalReviewStarted(ItemGuardianApprovalReviewStartedNotification)

item/autoApprovalReview/started

TerminalInteraction(TerminalInteractionNotification)

item/commandExecution/terminalInteraction

McpToolCallProgress(McpToolCallProgressNotification)

item/mcpToolCall/progress

ModelRerouted(ModelReroutedNotification)

model/rerouted

ModelVerification(ModelVerificationNotification)

model/verification

ProcessExited(ProcessExitedNotification)

process/exited

ProcessOutputDelta(ProcessOutputDeltaNotification)

process/outputDelta

ServerRequestResolved(ServerRequestResolvedNotification)

serverRequest/resolved

ContextCompacted(ContextCompactedNotification)

thread/compacted

ThreadGoalUpdated(ThreadGoalUpdatedNotification)

thread/goal/updated

ThreadRealtimeClosed(ThreadRealtimeClosedNotification)

thread/realtime/closed

ThreadRealtimeError(ThreadRealtimeErrorNotification)

thread/realtime/error

ThreadRealtimeItemAdded(ThreadRealtimeItemAddedNotification)

thread/realtime/itemAdded

ThreadRealtimeOutputAudioDelta(ThreadRealtimeOutputAudioDeltaNotification)

thread/realtime/outputAudio/delta

ThreadRealtimeSdp(ThreadRealtimeSdpNotification)

thread/realtime/sdp

ThreadRealtimeStarted(ThreadRealtimeStartedNotification)

thread/realtime/started

ThreadRealtimeTranscriptDelta(ThreadRealtimeTranscriptDeltaNotification)

thread/realtime/transcript/delta

ThreadRealtimeTranscriptDone(ThreadRealtimeTranscriptDoneNotification)

thread/realtime/transcript/done

WindowsWorldWritableWarning(WindowsWorldWritableWarningNotification)

windows/worldWritableWarning

WindowsSandboxSetupCompleted(WindowsSandboxSetupCompletedNotification)

windowsSandbox/setupCompleted

ThreadSettingsUpdated(ThreadSettingsUpdatedNotification)

thread/settings/updated

TurnModerationMetadata(TurnModerationMetadataNotification)

turn/moderationMetadata

ExternalAgentConfigImportProgress(ExternalAgentConfigImportProgressNotification)

externalAgentConfig/import/progress

ModelSafetyBufferingUpdated(ModelSafetyBufferingUpdatedNotification)

model/safetyBuffering/updated

ThreadEnvironmentConnected(EnvironmentConnectionNotification)

thread/environment/connected

ThreadEnvironmentDisconnected(EnvironmentConnectionNotification)

thread/environment/disconnected

Unknown

A method this crate version does not yet model. The raw params are preserved for caller inspection. Encountering this typically means the installed codex CLI is newer than the bindings.

Fields

method: String

params: Option<Value>

Implementations

impl Notification

pub fn method(&self) -> &str

Return the wire method string for this notification.

pub fn is_unknown(&self) -> bool

true if this notification’s method isn’t modeled by the crate.

pub fn turn_id(&self) -> Option<&str>

Return the turn id this notification is scoped to, if it carries one.

Reads the typed turnId field (or turn.id for the turn-lifecycle notifications) directly, so callers don’t have to round-trip through into_envelope and poke serde_json::Value fields. Returns None for notifications that aren’t turn-scoped, and treats an empty id the server omitted as absent.

The turn id from turn/started is what turn/interrupt needs to cancel the active turn.

pub fn thread_item(&self) -> Option<&ThreadItem>

Return the typed ThreadItem this notification carries, for item/started and item/completed.

Lets downstream event adapters read the item’s typed fields instead of reserializing it back into serde_json::Value.

pub fn from_envelope(method: &str, params: Option<Value>) -> Result<Self, Error>

Construct a Notification from a method + params envelope.

Returns an error if method is recognized but params doesn’t deserialize into the typed struct. Unknown methods route to Notification::Unknown without error.

pub fn into_envelope(self) -> Result<(String, Option<Value>), Error>

Decompose this notification back into a (method, params) pair.

Trait Implementations

impl Clone for Notification

fn clone(&self) -> Notification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Notification

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Notification

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Serialize for Notification

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.