Enum AgentMuxError 

pub enum AgentMuxError {
    OutOfSpace {
        path: String,
        source_msg: String,
    },
    PermissionDenied {
        path: String,
        source_msg: String,
    },
    PathNotFound {
        path: String,
    },
    PathTraversal {
        path: String,
    },
    MigrationFailed {
        from: u32,
        to: u32,
        message: String,
    },
    VersionMismatch {
        oid: String,
        expected: u64,
        actual: u64,
    },
    CliNotInstalled {
        provider: String,
        cli: String,
    },
    NpmInstallFailed {
        package: String,
        message: String,
    },
    CliShimMissing {
        provider: String,
        expected_path: String,
    },
    CliMissingOnPath {
        provider: String,
        cli: String,
        install_hint: String,
    },
    AuthRequiresTty {
        provider: String,
    },
    AuthTimeout {
        provider: String,
        seconds: u64,
    },
    HttpError {
        url: String,
        status: Option<u16>,
        message: String,
    },
    SidecarBindFailed {
        port: u16,
        message: String,
    },
    AlreadyRunning {
        pid: u32,
    },
    Legacy(String),
}

The typed error returned by RPC handlers. Serializes to: { "code": "AMX-IO-001", "message": "device out of space ...", "details": { ... } }

Variants

OutOfSpace

Fields

path: String

source_msg: String

PermissionDenied

Fields

path: String

source_msg: String

PathNotFound

Fields

path: String

PathTraversal

Fields

path: String

MigrationFailed

Fields

from: u32

to: u32

message: String

VersionMismatch

Fields

oid: String

expected: u64

actual: u64

CliNotInstalled

Fields

provider: String

cli: String

NpmInstallFailed

Fields

package: String

message: String

CliShimMissing

Fields

provider: String

expected_path: String

CliMissingOnPath

Fields

provider: String

cli: String

install_hint: String

AuthRequiresTty

Fields

provider: String

AuthTimeout

Fields

provider: String

seconds: u64

HttpError

Fields

url: String

status: Option<u16>

message: String

SidecarBindFailed

Fields

port: u16

message: String

AlreadyRunning

Fields

pid: u32

Legacy(String)

Implementations

impl AgentMuxError

pub fn code(&self) -> AmxCode

Stable code for this variant. Mirrors the JSON code field the frontend’s catalog looks up.

pub fn from_io_with_path(path: impl Into<String>, err: Error) -> Self

Helper for the common case: an std::io::Error raised while operating on a known path. Use this at call sites that have the path on hand — the From<std::io::Error> impl below can’t recover the path from the bare IO error.

pub fn to_wire(&self) -> Value

Serializes the error into the wire format the RPC engine emits. Frontend pattern-matches on code.

Trait Implementations

impl Debug for AgentMuxError

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

Formats the value using the given formatter.

impl Display for AgentMuxError

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

Formats the value using the given formatter.

impl Error for AgentMuxError

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<&str> for AgentMuxError

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Error> for AgentMuxError

fn from(err: Error) -> Self

Implicit conversion routes by ErrorKind + raw OS code, but loses the path context. Prefer from_io_with_path at sites that know which file/dir was being operated on — the empty path here renders as the literal (unknown path) sentinel in Display, which leaks into wire message and the Details disclosure.

impl From<String> for AgentMuxError

Wrap a free-text string in AgentMuxError::Legacy. Used by the RPC engine to bridge un-migrated handlers that still return Result<_, String>.

fn from(s: String) -> Self

Converts to this type from the input type.

impl Serialize for AgentMuxError

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

Serialize this value into the given Serde serializer.