Struct RunpodConfig 

pub struct RunpodConfig { /* private fields */ }

Configuration for the Runpod API client.

This struct holds all the necessary configuration parameters for creating and using a Runpod API client, including authentication credentials, API endpoint information, and HTTP client settings.

Examples

Creating a config with defaults:

let config = RunpodConfig::builder()
    .with_api_key("your-api-key")
    .build()
    .unwrap();

Creating a config from environment:

// Requires RUNPOD_API_KEY environment variable
let config = RunpodConfig::from_env().unwrap();

Custom configuration:

let config = RunpodConfig::builder()
    .with_api_key("your-api-key")
    .with_rest_url("https://custom.api.com")
    .with_timeout(Duration::from_secs(60))
    .build()
    .unwrap();

Implementations

impl RunpodConfig

pub fn builder() -> RunpodBuilder

Creates a new configuration builder.

This is the recommended way to construct a RunpodConfig.

Examples

let config = RunpodConfig::builder()
    .with_api_key("your-api-key")
    .build()
    .unwrap();

pub fn build_client(self) -> Result<RunpodClient>

Creates a new RunPod API client using this configuration.

Examples

let config = RunpodConfig::builder()
    .with_api_key("your-api-key")
    .build()
    .unwrap();

let client = config.build_client().unwrap();

pub fn api_key(&self) -> &str

Returns the API key.

pub fn masked_api_key(&self) -> String

Returns a masked version of the API key for safe display/logging.

Shows the first 4 characters followed by “”, or just “” if the key is shorter than 4 characters.

pub fn rest_url(&self) -> &str

Returns the base REST URL.

pub fn api_url(&self) -> &str

Available on crate feature serverless only.

Returns the API URL for serverless endpoints.

pub fn timeout(&self) -> Duration

Returns the timeout duration.

pub fn from_env() -> Result<Self>

Creates a configuration from environment variables.

Reads the API key from the RUNPOD_API_KEY environment variable. Optionally reads RUNPOD_REST_URL, RUNPOD_API_URL (with serverless feature), and RUNPOD_TIMEOUT_SECS if set.

Errors

Returns an error if:

• The RUNPOD_API_KEY environment variable is not set
• Any environment variable contains an invalid value

Examples

// Set environment variable first:
// export RUNPOD_API_KEY=your-api-key
let config = RunpodConfig::from_env().unwrap();

Trait Implementations

impl Clone for RunpodConfig

fn clone(&self) -> RunpodConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunpodConfig

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

Formats the value using the given formatter.