Struct ClientConfig 

pub struct ClientConfig {

    pub client_id: String,
    pub token: Option<AuthToken>,
    pub auth_proof_key_pem: Option<String>,
    pub authenticated_principal: Option<String>,
    pub server_key: Option<String>,
    pub descriptor_key_id: Option<String>,
    pub descriptor_public_key: Option<[u8; 32]>,
    pub tls_enabled: bool,
    pub tls_domain_name: Option<String>,
    pub tls_ca_certificate_pem: Option<String>,
    pub tls_skip_verify: bool,
    pub allow_insecure: bool,
    pub timeout_secs: u64,
    pub compression: bool,
    pub chunk_size: usize,
    pub chunked_transfer: bool,
    pub resumable_transfer: bool,
    pub pack_transfer: bool,
    pub partial_fetch: bool,
    pub provider_global_concurrency: usize,
    pub provider_per_endpoint_concurrency: usize,
    pub provider_max_inflight_bytes: usize,
    pub provider_stall_timeout_secs: u64,
}

Client configuration.

Fields

client_id: String

Client identifier.

token: Option<AuthToken>

Authentication token.

auth_proof_key_pem: Option<String>

Optional private key used to prove possession of a bound token.

authenticated_principal: Option<String>

Stable authenticated principal bound to the bearer token. Request signatures use this value as their canonical identity; the device key remains only the proof key.

server_key: Option<String>

Server key used to look up the credential in the credential store (~/.heddle/credentials.toml). Matches the key used by heddle auth login.

descriptor_key_id: Option<String>

Trusted descriptor-signing key identifier for native Iroh bootstrap.

descriptor_public_key: Option<[u8; 32]>

Raw Ed25519 public key for the trusted descriptor-signing key.

tls_enabled: bool

Enable TLS.

tls_domain_name: Option<String>

Override the expected TLS server name.

tls_ca_certificate_pem: Option<String>

Optional PEM CA certificate bundle for server verification.

tls_skip_verify: bool

Skip TLS certificate verification (insecure).

allow_insecure: bool

Explicitly allow cleartext (non-TLS) connections to non-loopback hosts.

Loopback cleartext is always permitted for local development. Non-loopback cleartext requires this flag (CLI --insecure, remote insecure = true, user config, or HEDDLE_REMOTE_INSECURE).

timeout_secs: u64

Connection timeout in seconds.

compression: bool

Enable compression.

chunk_size: usize

Preferred chunk size.

chunked_transfer: bool

Enable chunked transfer negotiation.

resumable_transfer: bool

Enable resumable transfer negotiation.

pack_transfer: bool

Enable pack transfer negotiation.

partial_fetch: bool

Enable partial fetch negotiation.

provider_global_concurrency: usize

Maximum provider extent streams active across all provider endpoints.

provider_per_endpoint_concurrency: usize

Maximum provider extent streams multiplexed over one endpoint connection.

provider_max_inflight_bytes: usize

Maximum provider body bytes retained between transport reads and spool writes.

provider_stall_timeout_secs: u64

Maximum seconds without provider transport progress before falling back.

Implementations

impl ClientConfig

pub fn new(client_id: impl Into<String>) -> ClientConfig

Create a new client configuration.

pub fn with_token(self, token: AuthToken) -> ClientConfig

Set authentication token.

pub fn with_auth_proof_key_pem(self, pem: impl Into<String>) -> ClientConfig

Set a private key used for proof-of-possession metadata.

pub fn with_authenticated_principal( self, principal: impl Into<String>, ) -> ClientConfig

Set the stable principal authenticated by the bearer token.

pub fn with_server_key(self, key: impl Into<String>) -> ClientConfig

Set the server key used to look up credentials in the credential store.

pub fn with_descriptor_trust( self, key_id: impl Into<String>, public_key: [u8; 32], ) -> ClientConfig

pub fn with_tls(self, skip_verify: bool) -> ClientConfig

Enable TLS.

pub fn with_tls_domain_name( self, domain_name: impl Into<String>, ) -> ClientConfig

pub fn with_tls_ca_certificate_pem(self, pem: impl Into<String>) -> ClientConfig

pub fn with_timeout(self, secs: u64) -> ClientConfig

Set timeout.

pub fn without_compression(self) -> ClientConfig

Disable compression.

pub fn with_chunk_size(self, size: usize) -> ClientConfig

Set chunk size.

pub fn with_chunked_transfer(self, enabled: bool) -> ClientConfig

Enable or disable chunked transfer negotiation.

pub fn with_resumable_transfer(self, enabled: bool) -> ClientConfig

Enable or disable resumable transfer negotiation.

pub fn with_pack_transfer(self, enabled: bool) -> ClientConfig

Enable or disable pack transfer negotiation.

pub fn with_partial_fetch(self, enabled: bool) -> ClientConfig

Enable or disable partial fetch negotiation.

pub fn with_provider_global_concurrency( self, concurrency: usize, ) -> ClientConfig

Set the maximum number of provider extent streams active globally.

pub fn with_provider_per_endpoint_concurrency( self, concurrency: usize, ) -> ClientConfig

Set the maximum provider extent streams multiplexed over one endpoint.

pub fn with_provider_max_inflight_bytes(self, bytes: usize) -> ClientConfig

Set the provider body-byte budget shared by all active extent streams.

pub fn with_provider_stall_timeout(self, secs: u64) -> ClientConfig

Set the provider transport progress threshold before ordinary Weft fallback.

pub fn with_allow_insecure(self, allow: bool) -> ClientConfig

Explicitly allow cleartext to non-loopback addresses.

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<(), Error>

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> ClientConfig

Returns the “default value” for a type.