Enum IntelApiError

pub enum IntelApiError {
    UnsupportedApiVersion(String),
    Reqwest(Error),
    UrlParse(ParseError),
    JsonError(Error),
    ApiError {
        status: StatusCode,
        request_id: String,
        error_code: Option<String>,
        error_message: Option<String>,
    },
    MissingOrInvalidHeader(&'static str),
    InvalidSubscriptionKey,
    ConflictingParameters(&'static str),
    Io(Error),
    HeaderValueParse(&'static str, String),
    InvalidParameter(&'static str),
    TooManyRequests {
        request_id: String,
        retry_after: u64,
    },
}

Represents all possible errors that can occur when interacting with Intel’s DCAP API.

Variants

UnsupportedApiVersion(String)

Indicates that the requested API version or feature is unsupported.

Reqwest(Error)

Wraps an underlying reqwest error.

UrlParse(ParseError)

Wraps a URL parsing error.

JsonError(Error)

Wraps a Serde JSON error.

ApiError

Represents a general API error, capturing the HTTP status and optional error details.

Fields

status: StatusCode

HTTP status code returned by the API.

request_id: String

The unique request identifier for tracing errors.

error_code: Option<String>

An optional server-provided error code.

error_message: Option<String>

An optional server-provided error message.

MissingOrInvalidHeader(&'static str)

Indicates that a header is missing or invalid.

InvalidSubscriptionKey

Represents an invalid subscription key.

ConflictingParameters(&'static str)

Indicates that conflicting parameters were supplied.

Io(Error)

Wraps a standard I/O error.

HeaderValueParse(&'static str, String)

Represents an error while parsing a header’s value.

InvalidParameter(&'static str)

Indicates an invalid parameter was provided.

TooManyRequests

Indicates that the API rate limit has been exceeded (HTTP 429).

This error is returned after the client has exhausted all automatic retry attempts for a rate-limited request. The retry_after field contains the number of seconds that was specified in the last Retry-After header. By default, the client automatically retries rate-limited requests up to 3 times.

Example

use intel_dcap_api::{ApiClient, IntelApiError};

let mut client = ApiClient::new()?;
client.set_max_retries(0); // Disable automatic retries

match client.get_sgx_tcb_info("00606A000000", None, None).await {
    Ok(tcb_info) => println!("Success"),
    Err(IntelApiError::TooManyRequests { request_id, retry_after }) => {
        println!("Rate limited after all retries. Last retry-after was {} seconds.", retry_after);
    }
    Err(e) => eprintln!("Other error: {}", e),
}

Fields

request_id: String

The unique request identifier for tracing.

retry_after: u64

Number of seconds to wait before retrying, from Retry-After header.

Trait Implementations

impl Debug for IntelApiError

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

Formats the value using the given formatter.

impl Display for IntelApiError

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

Formats the value using the given formatter.

impl Error for IntelApiError

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 IntelApiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for IntelApiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for IntelApiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for IntelApiError

fn from(source: ParseError) -> Self

Converts to this type from the input type.