Enum ApiErrorCode 

#[repr(u32)]
pub enum ApiErrorCode {
    MalformedRequest = 40_010_000,
    InvalidCredentials = 40_110_000,
    Forbidden = 40_310_000,
    NotFound = 40_410_000,
    UnprocessableEntity = 42_210_000,
    RateLimitExceeded = 42_910_000,
    InternalServerError = 50_010_000,
    Unknown = 0,
}

Alpaca-specific API error codes.

These codes are returned by the Alpaca API to indicate specific error conditions.

Variants

MalformedRequest = 40_010_000

Malformed request body or parameters.

InvalidCredentials = 40_110_000

Invalid or missing authentication credentials.

Forbidden = 40_310_000

Access forbidden for this resource.

NotFound = 40_410_000

Requested resource not found.

UnprocessableEntity = 42_210_000

Request validation failed.

RateLimitExceeded = 42_910_000

Rate limit exceeded.

InternalServerError = 50_010_000

Internal server error.

Unknown = 0

Unknown error code.

Implementations

impl ApiErrorCode

pub fn from_code(code: u32) -> Self

Creates an ApiErrorCode from a numeric code.

Examples found in repository

examples/base_error_handling.rs (line 58)

fn demonstrate_error_codes() {
    // Convert numeric codes to typed error codes
    let codes = [
        (40010000, "Malformed Request"),
        (40110000, "Invalid Credentials"),
        (40310000, "Forbidden"),
        (40410000, "Not Found"),
        (42210000, "Unprocessable Entity"),
        (42910000, "Rate Limit Exceeded"),
        (50010000, "Internal Server Error"),
    ];

    for (code, description) in codes {
        let error_code = ApiErrorCode::from_code(code);
        println!(
            "  Code {}: {} (client_error={}, server_error={})",
            code,
            description,
            error_code.is_client_error(),
            error_code.is_server_error()
        );
    }
}

pub fn as_code(&self) -> u32

Returns the numeric code for this error.

pub fn is_client_error(&self) -> bool

Returns true if this is a client error (4xx).

Examples found in repository

examples/base_error_handling.rs (line 63)

fn demonstrate_error_codes() {
    // Convert numeric codes to typed error codes
    let codes = [
        (40010000, "Malformed Request"),
        (40110000, "Invalid Credentials"),
        (40310000, "Forbidden"),
        (40410000, "Not Found"),
        (42210000, "Unprocessable Entity"),
        (42910000, "Rate Limit Exceeded"),
        (50010000, "Internal Server Error"),
    ];

    for (code, description) in codes {
        let error_code = ApiErrorCode::from_code(code);
        println!(
            "  Code {}: {} (client_error={}, server_error={})",
            code,
            description,
            error_code.is_client_error(),
            error_code.is_server_error()
        );
    }
}

pub fn is_server_error(&self) -> bool

Returns true if this is a server error (5xx).

Examples found in repository

examples/base_error_handling.rs (line 64)

fn demonstrate_error_codes() {
    // Convert numeric codes to typed error codes
    let codes = [
        (40010000, "Malformed Request"),
        (40110000, "Invalid Credentials"),
        (40310000, "Forbidden"),
        (40410000, "Not Found"),
        (42210000, "Unprocessable Entity"),
        (42910000, "Rate Limit Exceeded"),
        (50010000, "Internal Server Error"),
    ];

    for (code, description) in codes {
        let error_code = ApiErrorCode::from_code(code);
        println!(
            "  Code {}: {} (client_error={}, server_error={})",
            code,
            description,
            error_code.is_client_error(),
            error_code.is_server_error()
        );
    }
}

pub fn is_retryable(&self) -> bool

Returns true if this error is retryable.

Trait Implementations

impl Clone for ApiErrorCode

fn clone(&self) -> ApiErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiErrorCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiErrorCode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ApiErrorCode

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

Formats the value using the given formatter.

impl Error for ApiErrorCode

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 PartialEq for ApiErrorCode

fn eq(&self, other: &ApiErrorCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ApiErrorCode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ApiErrorCode

impl Eq for ApiErrorCode

impl StructuralPartialEq for ApiErrorCode