Enum SerpError 

#[non_exhaustive]
pub enum SerpError {
    MissingApiKey,
    ClientBuilder(String),
    RequestFailed(Error),
    InvalidResponse(String),
    RateLimited {
        retry_after: u64,
    },
    ApiError {
        code: u16,
        message: String,
    },
    Serialization(Error),
    UrlEncoding(Error),
    InvalidParameter(String),
    Timeout,
    Network(String),
}

Comprehensive error types for SerpAPI SDK operations.

This enum covers all possible error conditions that can occur when using the SDK, from configuration issues to network problems and API-specific errors.

Examples

use serp_sdk::{SerpClient, SerpError};

// Handle specific error types
match SerpClient::builder().build() {
    Ok(client) => println!("Client created successfully"),
    Err(SerpError::MissingApiKey) => {
        println!("Please set SERP_API_KEY environment variable");
    }
    Err(e) => println!("Other error: {}", e),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MissingApiKey

API key not provided via builder or environment variable.

Set the API key using SerpClientBuilder::api_key or the SERP_API_KEY environment variable.

ClientBuilder(String)

Error during HTTP client construction.

This typically indicates an issue with the underlying HTTP client configuration, such as invalid TLS settings or proxy configuration.

RequestFailed(Error)

HTTP request failed.

This wraps underlying reqwest::Error and can indicate network connectivity issues, DNS resolution failures, or connection timeouts.

InvalidResponse(String)

Response could not be parsed or has invalid format.

This occurs when the API returns a response that doesn’t match the expected JSON structure, which might indicate API changes or corrupted responses.

RateLimited

Rate limit exceeded, with retry-after duration.

SerpAPI has rate limits. When exceeded, this error includes the number of seconds to wait before retrying. The SDK’s retry logic handles this automatically.

Fields

retry_after: u64

Number of seconds to wait before retrying

ApiError

API returned an error response.

This represents HTTP error status codes (4xx, 5xx) returned by the SerpAPI service, such as authentication failures or server errors.

Fields

code: u16

HTTP status code

message: String

Error message from the API

Serialization(Error)

JSON serialization/deserialization error.

This wraps serde_json::Error and occurs when request parameters cannot be serialized or response data cannot be deserialized.

UrlEncoding(Error)

URL encoding error.

This occurs when query parameters cannot be properly URL-encoded, typically due to invalid characters in parameter values.

InvalidParameter(String)

Invalid query parameter.

This is thrown when query parameters fail validation, such as setting a limit outside the valid range (1-100).

Timeout

Timeout during request execution.

The request exceeded the configured timeout duration. Adjust the timeout using SerpClientBuilder::timeout.

Network(String)

Network connectivity issues.

This represents lower-level network problems that don’t fit into other categories, such as proxy failures or DNS issues.

Trait Implementations

impl Debug for SerpError

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

Formats the value using the given formatter.

impl Display for SerpError

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

Formats the value using the given formatter.

impl Error for SerpError

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 SerpError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SerpError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SerpError

fn from(source: Error) -> Self

Converts to this type from the input type.