Enum OpenRouterError

pub enum OpenRouterError {
    HttpRequest(Error),
    ApiError {
        code: StatusCode,
        message: String,
    },
    ModerationError {
        code: StatusCode,
        message: String,
        reasons: Vec<String>,
        flagged_input: String,
        provider_name: String,
        model_slug: String,
    },
    ProviderError {
        code: StatusCode,
        message: String,
        provider_name: String,
        raw: Value,
    },
    ApiErrorWithMetadata {
        code: StatusCode,
        message: String,
        metadata: Value,
    },
    ConfigError(String),
    ConfigNotFound(PathBuf),
    KeyNotConfigured,
    UninitializedFieldError(UninitializedFieldError),
    Serialization(Error),
    Io(Error),
    Unknown(String),
}

Comprehensive error type for OpenRouter SDK operations

This enum covers all possible error conditions that can occur when using the OpenRouter SDK, from network issues to API-specific errors. All variants implement std::error::Error and provide detailed context information.

Examples

use openrouter_rs::error::OpenRouterError;
use surf::StatusCode;

// Pattern matching on specific error types
fn handle_error(error: OpenRouterError) {
    match error {
        OpenRouterError::ApiError { code: StatusCode::Unauthorized, .. } => {
            println!("Check your API key");
        }
        OpenRouterError::ModerationError { reasons, .. } => {
            println!("Content flagged for: {:?}", reasons);
        }
        OpenRouterError::ConfigError(msg) => {
            println!("Configuration issue: {}", msg);
        }
        _ => println!("Other error: {}", error),
    }
}

Variants

HttpRequest(Error)

ApiError

Fields

code: StatusCode

message: String

ModerationError

Fields

code: StatusCode

message: String

reasons: Vec<String>

flagged_input: String

provider_name: String

model_slug: String

ProviderError

Fields

code: StatusCode

message: String

provider_name: String

raw: Value

ApiErrorWithMetadata

Fields

code: StatusCode

message: String

metadata: Value

ConfigError(String)

ConfigNotFound(PathBuf)

KeyNotConfigured

UninitializedFieldError(UninitializedFieldError)

Serialization(Error)

Io(Error)

Unknown(String)

Trait Implementations

impl Debug for OpenRouterError

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

Formats the value using the given formatter.

impl Display for OpenRouterError

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

Formats the value using the given formatter.

impl Error for OpenRouterError

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<ApiErrorResponse> for OpenRouterError

fn from(api_error_response: ApiErrorResponse) -> Self

Converts to this type from the input type.

impl From<Error> for OpenRouterError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for OpenRouterError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for OpenRouterError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<UninitializedFieldError> for OpenRouterError

fn from(source: UninitializedFieldError) -> Self

Converts to this type from the input type.