Struct ClientConfig 

pub struct ClientConfig {

    pub client_id: String,
    pub token: Option<AuthToken>,
    pub auth_proof_key_pem: Option<String>,
    pub server_key: Option<String>,
    pub tls_enabled: bool,
    pub tls_domain_name: Option<String>,
    pub tls_ca_certificate_pem: Option<String>,
    pub tls_skip_verify: 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,
}

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.

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.

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).

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.

Implementations

impl ClientConfig

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

Create a new client configuration.

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

Set authentication token.

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

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

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

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

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

Enable TLS.

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

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

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

Set timeout.

pub fn without_compression(self) -> Self

Disable compression.

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

Set chunk size.

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

Enable or disable chunked transfer negotiation.

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

Enable or disable resumable transfer negotiation.

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

Enable or disable pack transfer negotiation.

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

Enable or disable partial fetch negotiation.

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.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.