Enum CopilotError 

pub enum CopilotError {
    Transport(Error),
    ConnectionClosed,
    NotConnected,
    JsonRpc {
        code: i32,
        message: String,
        data: Option<Value>,
    },
    ProtocolMismatch {
        expected: u32,
        actual: u32,
    },
    Protocol(String),
    Json(Error),
    Timeout(Duration),
    SessionNotFound(String),
    SessionDestroyed,
    InvalidConfig(String),
    ProcessStart(Error),
    ProcessExit(Option<i32>),
    PortDetectionFailed,
    Shutdown,
    ToolNotFound(String),
    ToolError(String),
    PermissionDenied(String),
    ChannelError,
}

Main error type for the Copilot SDK.

Variants

Transport(Error)

Transport/IO error

ConnectionClosed

Connection was closed unexpectedly

NotConnected

Client is not connected

JsonRpc

JSON-RPC error from server

Fields

code: i32

message: String

data: Option<Value>

ProtocolMismatch

Protocol version mismatch

Fields

expected: u32

actual: u32

Protocol(String)

Protocol error (framing, invalid messages, etc.)

Json(Error)

JSON serialization/deserialization error

Timeout(Duration)

Request timed out

SessionNotFound(String)

Session not found

SessionDestroyed

Session was already destroyed

InvalidConfig(String)

Invalid configuration

ProcessStart(Error)

Failed to start CLI process

ProcessExit(Option<i32>)

CLI process exited unexpectedly

PortDetectionFailed

Port detection failed in TCP mode

Shutdown

Client is shutting down

ToolNotFound(String)

Tool not found

ToolError(String)

Tool execution error

PermissionDenied(String)

Permission denied

ChannelError

Channel send error (internal)

Implementations

impl CopilotError

pub fn json_rpc( code: i32, message: impl Into<String>, data: Option<Value>, ) -> Self

Create a JSON-RPC error from components.

pub fn invalid_config(msg: impl Into<String>) -> Self

Create an invalid config error.

pub fn is_fatal(&self) -> bool

Returns true if this error indicates the connection is no longer usable.

Trait Implementations

impl Debug for CopilotError

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

Formats the value using the given formatter.

impl Display for CopilotError

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

Formats the value using the given formatter.

impl Error for CopilotError

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.

impl From<Error> for CopilotError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CopilotError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<RecvError> for CopilotError

fn from(_: RecvError) -> Self

Converts to this type from the input type.