Struct AuthConfig 

pub struct AuthConfig {
    pub api_key: Secret<String>,
    pub base_url: String,
    pub timeout_seconds: u64,
    pub max_retries: u32,
    pub enable_retry: bool,
    pub user_agent: String,
}

Configuration for authentication and client behavior.

AuthConfig holds all the necessary information for authenticating with the Rainy API, as well as settings for request behavior like timeouts and retries.

Examples

use rainy_sdk::auth::AuthConfig;

let config = AuthConfig::new("your-api-key")
    .with_base_url("https://api.example.com")
    .with_timeout(60)
    .with_max_retries(5);

assert_eq!(config.base_url, "https://api.example.com");
assert_eq!(config.timeout_seconds, 60);
assert_eq!(config.max_retries, 5);

Fields

api_key: Secret<String>

The API key used for authenticating with the Rainy API.

base_url: String

The base URL of the Rainy API. Defaults to the official endpoint.

timeout_seconds: u64

The timeout for HTTP requests, in seconds.

max_retries: u32

The maximum number of times to retry a failed request.

enable_retry: bool

A flag to enable or disable automatic retries with exponential backoff.

user_agent: String

The user agent string to send with each request.

Implementations

impl AuthConfig

pub fn new(api_key: impl Into<String>) -> Self

Creates a new AuthConfig with the given API key and default settings.

Arguments

• api_key - Your Rainy API key.

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Sets a custom base URL for the API.

Arguments

• base_url - The new base URL to use.

pub fn with_timeout(self, seconds: u64) -> Self

Sets a custom timeout for HTTP requests.

Arguments

• seconds - The timeout duration in seconds.

pub fn with_max_retries(self, retries: u32) -> Self

Sets the maximum number of retry attempts for failed requests.

Arguments

• retries - The maximum number of retries.

pub fn with_retry(self, enable: bool) -> Self

Enables or disables automatic retries.

Arguments

• enable - true to enable retries, false to disable.

pub fn with_user_agent(self, user_agent: impl Into<String>) -> Self

Sets a custom user agent string for requests.

Arguments

• user_agent - The new user agent string.

pub fn validate(&self) -> Result<()>

Validates the AuthConfig settings.

This method checks for common configuration errors, such as an empty API key or an invalid base URL.

Returns

A Result that is Ok(()) if the configuration is valid, or a RainyError if it’s not.

pub fn build_headers(&self) -> Result<HeaderMap>

Builds the necessary HTTP headers for an API request.

This method constructs a HeaderMap containing the Authorization and User-Agent headers based on the AuthConfig.

Returns

A Result containing the HeaderMap or a RainyError if header creation fails.

pub fn timeout(&self) -> Duration

Returns the request timeout as a Duration.

Trait Implementations

impl Clone for AuthConfig

fn clone(&self) -> AuthConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthConfig

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

Formats the value using the given formatter.

impl Display for AuthConfig

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

Formats the value using the given formatter.