Enum AiMuxError 

pub enum AiMuxError {
    Provider(String),
    Http(String),
    Json(String),
    Stream(String),
    Tool(String),
    InvalidArgument(String),
    InvalidPrompt(String),
    RateLimited {
        retry_after_ms: u64,
    },
    Auth(String),
    TokenExpired(String),
    ModelNotFound(String),
    Unsupported(String),
    NoSuchModel(String),
    UnknownProvider(String),
    ApiCall(String),
    Timeout(String),
    Aborted,
    Other(String),
}

Unified error type for all aimux operations.

Variants

Provider(String)

Http(String)

Json(String)

Stream(String)

Tool(String)

InvalidArgument(String)

InvalidPrompt(String)

RateLimited

Fields

retry_after_ms: u64

Auth(String)

TokenExpired(String)

The access token has expired (or was invalidated) and must be refreshed by the caller. RFC-0018 subscription mode: the library maps a 401 from the Codex subscription endpoint to this variant; the integrator orchestrates codex_refresh + retry.

ModelNotFound(String)

Unsupported(String)

NoSuchModel(String)

UnknownProvider(String)

ApiCall(String)

Timeout(String)

Aborted

Other(String)

Implementations

impl AiMuxError

pub fn is_retryable(&self) -> bool

Returns true if the error is transient and can be retried.

pub fn retry_after_hint(&self) -> Option<i64>

Returns the retry-after delay hint (in milliseconds) carried by this error, if any. Currently only RateLimited carries a hint (from a retry-after-ms / retry-after response header). Returns None for errors that don’t advertise a delay, in which case the retry strategy falls back to exponential backoff.

Mirrors the header-consulting behaviour of retryWithExponentialBackoffRespectingRetryHeaders in the TS SDK.

pub fn error_type(&self) -> &'static str

Returns the error variant name as a string (e.g. "Auth", "Provider", "RateLimited"). Used by FFI bindings to give callers a machine-readable error type alongside the human-readable message.

pub fn status_code(&self) -> Option<u16>

Returns the HTTP status code carried by this error, if any.

HTTP-layer errors created by parse_provider_error and send_with_retry_raw embed the status code in the message as "HTTP {status}: ...". This method extracts it. Errors that don’t originate from an HTTP response return None.

Trait Implementations

impl Clone for AiMuxError

fn clone(&self) -> AiMuxError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AiMuxError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AiMuxError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AiMuxError

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

Formats the value using the given formatter.

impl Error for AiMuxError

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 AiMuxError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl Serialize for AiMuxError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for AiMuxError

type WithoutGenerics = AiMuxError

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = AiMuxError

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.