Skip to main content

SessionEventType

github_copilot_sdk::session_events

Enum SessionEventType

pub enum SessionEventType {
Show 103 variants    SessionStart,
    SessionResume,
    SessionRemoteSteerableChanged,
    SessionError,
    SessionIdle,
    SessionTitleChanged,
    SessionScheduleCreated,
    SessionScheduleCancelled,
    SessionScheduleRearmed,
    SessionAutopilotObjectiveChanged,
    SessionInfo,
    SessionWarning,
    SessionModelChange,
    SessionModeChanged,
    SessionSessionLimitsChanged,
    SessionPermissionsChanged,
    SessionPlanChanged,
    SessionTodosChanged,
    SessionWorkspaceFileChanged,
    SessionHandoff,
    SessionTruncation,
    SessionSnapshotRewind,
    SessionShutdown,
    SessionUsageCheckpoint,
    SessionContextChanged,
    SessionUsageInfo,
    SessionCompactionStart,
    SessionCompactionComplete,
    SessionTaskComplete,
    UserMessage,
    PendingMessagesModified,
    AssistantTurnStart,
    AssistantIntent,
    AssistantReasoning,
    AssistantReasoningDelta,
    AssistantStreamingDelta,
    AssistantMessage,
    AssistantMessageStart,
    AssistantMessageDelta,
    AssistantTurnEnd,
    AssistantIdle,
    AssistantUsage,
    ModelCallFailure,
    Abort,
    ToolUserRequested,
    ToolExecutionStart,
    ToolExecutionPartialResult,
    ToolExecutionProgress,
    ToolExecutionComplete,
    SkillInvoked,
    SubagentStarted,
    SubagentCompleted,
    SubagentFailed,
    SubagentSelected,
    SubagentDeselected,
    HookStart,
    HookEnd,
    HookProgress,
    SessionBinaryAsset,
    SystemMessage,
    SystemNotification,
    PermissionRequested,
    PermissionCompleted,
    UserInputRequested,
    UserInputCompleted,
    ElicitationRequested,
    ElicitationCompleted,
    SamplingRequested,
    SamplingCompleted,
    McpOauthRequired,
    McpOauthCompleted,
    McpHeadersRefreshRequired,
    McpHeadersRefreshCompleted,
    SessionCustomNotification,
    ExternalToolRequested,
    ExternalToolCompleted,
    CommandQueued,
    CommandExecute,
    CommandCompleted,
    AutoModeSwitchRequested,
    AutoModeSwitchCompleted,
    SessionLimitsExhaustedRequested,
    SessionLimitsExhaustedCompleted,
    CommandsChanged,
    CapabilitiesChanged,
    ExitPlanModeRequested,
    ExitPlanModeCompleted,
    SessionToolsUpdated,
    SessionBackgroundTasksChanged,
    SessionSkillsLoaded,
    SessionCustomAgentsUpdated,
    SessionMcpServersLoaded,
    SessionMcpServerStatusChanged,
    SessionExtensionsLoaded,
    SessionCanvasOpened,
    SessionCanvasRegistryChanged,
    SessionCanvasClosed,
    SessionCanvasUnavailable,
    SessionCanvasRecorded,
    SessionCanvasRemoved,
    SessionExtensionsAttachmentsPushed,
    McpAppToolCallComplete,
    Unknown,
}

Expand description

Identifies the kind of session event.

Variants§

SessionStart

SessionResume

SessionRemoteSteerableChanged

SessionError

SessionIdle

SessionTitleChanged

SessionScheduleCreated

SessionScheduleCancelled

SessionScheduleRearmed

SessionAutopilotObjectiveChanged

SessionInfo

SessionWarning

SessionModelChange

SessionModeChanged

SessionSessionLimitsChanged

SessionPermissionsChanged

SessionPlanChanged

SessionTodosChanged

SessionWorkspaceFileChanged

SessionHandoff

SessionTruncation

SessionSnapshotRewind

SessionShutdown

SessionUsageCheckpoint

SessionContextChanged

SessionUsageInfo

SessionCompactionStart

SessionCompactionComplete

SessionTaskComplete

UserMessage

PendingMessagesModified

AssistantTurnStart

AssistantIntent

AssistantReasoning

AssistantReasoningDelta

AssistantStreamingDelta

AssistantMessage

AssistantMessageStart

AssistantMessageDelta

AssistantTurnEnd

AssistantIdle

AssistantUsage

ModelCallFailure

Abort

ToolUserRequested

ToolExecutionStart

ToolExecutionPartialResult

ToolExecutionProgress

ToolExecutionComplete

SkillInvoked

SubagentStarted

SubagentCompleted

SubagentFailed

SubagentSelected

SubagentDeselected

HookStart

HookEnd

HookProgress

SessionBinaryAsset

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

SystemMessage

SystemNotification

PermissionRequested

PermissionCompleted

UserInputRequested

UserInputCompleted

ElicitationRequested

ElicitationCompleted

SamplingRequested

SamplingCompleted

McpOauthRequired

McpOauthCompleted

McpHeadersRefreshRequired

McpHeadersRefreshCompleted

SessionCustomNotification

ExternalToolRequested

ExternalToolCompleted

CommandQueued

CommandExecute

CommandCompleted

AutoModeSwitchRequested

AutoModeSwitchCompleted

SessionLimitsExhaustedRequested

SessionLimitsExhaustedCompleted

CommandsChanged

CapabilitiesChanged

ExitPlanModeRequested

ExitPlanModeCompleted

SessionToolsUpdated

SessionBackgroundTasksChanged

SessionSkillsLoaded

SessionCustomAgentsUpdated

SessionMcpServersLoaded

SessionMcpServerStatusChanged

SessionExtensionsLoaded

SessionCanvasOpened

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

SessionCanvasRegistryChanged

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

SessionCanvasClosed

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

SessionCanvasUnavailable

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

SessionCanvasRecorded

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

SessionCanvasRemoved

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

SessionExtensionsAttachmentsPushed

McpAppToolCallComplete

Unknown

Unknown event type for forward compatibility.

Trait Implementations§

impl Clone for SessionEventType

fn clone(&self) -> SessionEventType

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for SessionEventType

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

Formats the value using the given formatter. Read more

impl Default for SessionEventType

fn default() -> SessionEventType

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for SessionEventType

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

Deserialize this value from the given Serde deserializer. Read more

impl Eq for SessionEventType

impl Hash for SessionEventType

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for SessionEventType

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SessionEventType

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for SessionEventType

Auto Trait Implementations§

impl Freeze for SessionEventType

impl RefUnwindSafe for SessionEventType

impl Send for SessionEventType

impl Sync for SessionEventType

impl Unpin for SessionEventType

impl UnsafeUnpin for SessionEventType

impl UnwindSafe for SessionEventType

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more