Enum SessionError 

#[non_exhaustive]
pub enum SessionError {
    NotFound(SessionId),
    AgentError(String),
    Timeout(Duration),
    SendWhileWaiting,
    EventLoopClosed,
    ElicitationNotSupported,
    SessionFsProviderRequired,
    InvalidSessionFsConfig(String),
    SessionIdMismatch {
        requested: SessionId,
        returned: SessionId,
    },
}

Session-scoped errors.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NotFound(SessionId)

The CLI could not find the requested session.

AgentError(String)

The CLI reported an error during agent execution (via session.error event).

Timeout(Duration)

A send_and_wait call exceeded its timeout.

SendWhileWaiting

send was called while a send_and_wait is in flight.

EventLoopClosed

The session event loop exited before a pending send_and_wait completed.

ElicitationNotSupported

Elicitation is not supported by the host. Check session.capabilities().ui.elicitation before calling UI methods.

SessionFsProviderRequired

The client was started with ClientOptions::session_fs but this session was created without a SessionFsProvider. Set one via SessionConfig::with_session_fs_provider (or ResumeSessionConfig::with_session_fs_provider).

InvalidSessionFsConfig(String)

ClientOptions::session_fs was provided with empty or invalid fields. All of initial_cwd and session_state_path must be non-empty.

SessionIdMismatch

The CLI returned a different session ID than the one the SDK registered.

Fields

requested: SessionId

Session ID registered by the SDK before the RPC was sent.

returned: SessionId

Session ID returned by the CLI.

Trait Implementations

impl Debug for SessionError

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

Formats the value using the given formatter.

impl Display for SessionError

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

Formats the value using the given formatter.

impl Error for SessionError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.