Struct ApiErrorResponse 

pub struct ApiErrorResponse {
    pub code: u32,
    pub message: String,
    pub request_id: Option<String>,
}

Detailed API error response from Alpaca.

Fields

code: u32

The error code returned by Alpaca.

message: String

The error message.

request_id: Option<String>

Optional request ID for debugging.

Implementations

impl ApiErrorResponse

pub fn new(code: u32, message: impl Into<String>) -> Self

Creates a new API error response.

Examples found in repository

examples/base_error_handling.rs (line 174)

fn demonstrate_error_matching() {
    let error = AlpacaError::api_with_details(
        404,
        "order not found",
        ApiErrorCode::NotFound,
        Some("req-12345".to_string()),
    );

    // Pattern match on error type
    match &error {
        AlpacaError::Api {
            status,
            message,
            error_code,
            request_id,
        } => {
            println!("  API Error detected:");
            println!("    - Status: {}", status);
            println!("    - Message: {}", message);
            println!("    - Error code: {:?}", error_code);
            println!("    - Request ID: {:?}", request_id);
        }
        AlpacaError::RateLimit {
            retry_after_secs, ..
        } => {
            println!("  Rate limited, retry after {} seconds", retry_after_secs);
        }
        _ => {
            println!("  Other error: {}", error);
        }
    }

    // Use helper methods
    println!("\n  Helper methods:");
    println!("    - status_code(): {:?}", error.status_code());
    println!("    - request_id(): {:?}", error.request_id());
    println!("    - is_retryable(): {}", error.is_retryable());

    // API error response parsing
    let response =
        ApiErrorResponse::new(40410000, "resource not found").with_request_id("req-67890");
    println!("\n  Parsed API response:");
    println!("    - Code: {}", response.code);
    println!("    - Message: {}", response.message);
    println!("    - Typed code: {:?}", response.error_code());
}

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Sets the request ID.

Examples found in repository

examples/base_error_handling.rs (line 174)

fn demonstrate_error_matching() {
    let error = AlpacaError::api_with_details(
        404,
        "order not found",
        ApiErrorCode::NotFound,
        Some("req-12345".to_string()),
    );

    // Pattern match on error type
    match &error {
        AlpacaError::Api {
            status,
            message,
            error_code,
            request_id,
        } => {
            println!("  API Error detected:");
            println!("    - Status: {}", status);
            println!("    - Message: {}", message);
            println!("    - Error code: {:?}", error_code);
            println!("    - Request ID: {:?}", request_id);
        }
        AlpacaError::RateLimit {
            retry_after_secs, ..
        } => {
            println!("  Rate limited, retry after {} seconds", retry_after_secs);
        }
        _ => {
            println!("  Other error: {}", error);
        }
    }

    // Use helper methods
    println!("\n  Helper methods:");
    println!("    - status_code(): {:?}", error.status_code());
    println!("    - request_id(): {:?}", error.request_id());
    println!("    - is_retryable(): {}", error.is_retryable());

    // API error response parsing
    let response =
        ApiErrorResponse::new(40410000, "resource not found").with_request_id("req-67890");
    println!("\n  Parsed API response:");
    println!("    - Code: {}", response.code);
    println!("    - Message: {}", response.message);
    println!("    - Typed code: {:?}", response.error_code());
}

pub fn error_code(&self) -> ApiErrorCode

Returns the typed error code.

Examples found in repository

examples/base_error_handling.rs (line 178)

fn demonstrate_error_matching() {
    let error = AlpacaError::api_with_details(
        404,
        "order not found",
        ApiErrorCode::NotFound,
        Some("req-12345".to_string()),
    );

    // Pattern match on error type
    match &error {
        AlpacaError::Api {
            status,
            message,
            error_code,
            request_id,
        } => {
            println!("  API Error detected:");
            println!("    - Status: {}", status);
            println!("    - Message: {}", message);
            println!("    - Error code: {:?}", error_code);
            println!("    - Request ID: {:?}", request_id);
        }
        AlpacaError::RateLimit {
            retry_after_secs, ..
        } => {
            println!("  Rate limited, retry after {} seconds", retry_after_secs);
        }
        _ => {
            println!("  Other error: {}", error);
        }
    }

    // Use helper methods
    println!("\n  Helper methods:");
    println!("    - status_code(): {:?}", error.status_code());
    println!("    - request_id(): {:?}", error.request_id());
    println!("    - is_retryable(): {}", error.is_retryable());

    // API error response parsing
    let response =
        ApiErrorResponse::new(40410000, "resource not found").with_request_id("req-67890");
    println!("\n  Parsed API response:");
    println!("    - Code: {}", response.code);
    println!("    - Message: {}", response.message);
    println!("    - Typed code: {:?}", response.error_code());
}

Trait Implementations

impl Clone for ApiErrorResponse

fn clone(&self) -> ApiErrorResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiErrorResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiErrorResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiErrorResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.