Struct ClientConfig 

pub struct ClientConfig { /* private fields */ }

configuration for the infrahub client

Implementations

impl ClientConfig

pub fn new(base_url: impl AsRef<str>, token: impl Into<String>) -> Self

create a new client configuration

arguments

• base_url - the base url of the infrahub instance (with or without trailing slash)
• token - the api authentication token

example

use infrahub::ClientConfig;

let config = ClientConfig::new("https://infrahub.example.com", "your-token-here");

Examples found in repository

examples/typed_query.rs (line 25)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let base_url = env::var("INFRAHUB_URL").unwrap_or_else(|_| "http://localhost:8000".to_string());
    let token = env::var("INFRAHUB_TOKEN").expect("INFRAHUB_TOKEN is required");
    let branch = env::var("INFRAHUB_BRANCH").ok();

    let config = ClientConfig::new(base_url, token);
    let client = Client::new(config)?;

    let response = client
        .execute::<Data>(
            "query { InfrahubInfo { deployment_id version } }",
            None,
            branch.as_deref(),
        )
        .await?;

    println!("response: {response:?}");
    Ok(())
}

examples/simple_query.rs (line 10)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let base_url = env::var("INFRAHUB_URL").unwrap_or_else(|_| "http://localhost:8000".to_string());
    let token = env::var("INFRAHUB_TOKEN").expect("INFRAHUB_TOKEN is required");
    let branch = env::var("INFRAHUB_BRANCH").ok();

    let config = ClientConfig::new(base_url, token);
    let client = Client::new(config)?;

    let response = client
        .execute_raw(
            "{ InfrahubInfo { deployment_id version } }",
            None,
            branch.as_deref(),
        )
        .await?;

    println!("data: {}", response.data.unwrap_or_default());

    Ok(())
}

pub fn with_default_branch(self, branch: impl Into<String>) -> Self

set the default branch for graphql queries

pub fn with_timeout(self, timeout: Duration) -> Self

set the request timeout

default: 30 seconds

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

set a custom user agent string

pub fn with_ssl_verification(self, verify: bool) -> Self

disable ssl certificate verification (not recommended for production)

default: enabled

pub fn with_header(self, name: HeaderName, value: HeaderValue) -> Self

add a header to every request

pub fn with_headers(self, headers: HeaderMap) -> Self

add a set of headers to every request

pub fn extra_headers(&self) -> &HeaderMap

access extra headers configured on this client

pub fn with_http_client(self, http_client: Client) -> Self

inject a prebuilt http client.

when set, this client is used as-is and takes precedence over with_http_client_builder. all transport configuration — auth headers, tls, timeouts, ssl verification, user agent — comes from the prebuilt client; the corresponding ClientConfig fields are ignored.

because auth is managed by the caller, an empty token is accepted when this option is set.

pub fn with_http_client_builder<F>(self, f: F) -> Self

where F: Fn(ClientBuilder) -> ClientBuilder + Send + Sync + 'static,

customize the http client builder before the client is created.

the callback receives a builder that already has the auth header, extra headers, user agent, timeout, and ssl settings applied. use this to add proxy config, custom tls roots, or other transport settings without reimplementing the defaults.

ignored if with_http_client is also set.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.