Struct ClientConfig 

pub struct ClientConfig {
    pub socket_path: PathBuf,
    pub port_path: PathBuf,
    pub project_root: String,
    pub expected_schema_version: u32,
    pub connect_timeout: Duration,
    pub poll_interval: Duration,
    pub spawn: Spawner,
    pub transport: Transport,
    pub spawn_log_path: Option<PathBuf>,
}

Configuration for a Client.

Fields

socket_path: PathBuf

Unix domain socket the daemon listens on (~/.kindling/kindling.sock by default). Used when Self::transport is Transport::Uds.

port_path: PathBuf

File the daemon publishes its TCP port to (~/.kindling/kindling.port by default). Read when Self::transport is Transport::Tcp.

project_root: String

Project root string, sent as the X-Kindling-Project header on every data endpoint. The daemon hashes it to route to a per-project DB. Defaults to the current working directory.

expected_schema_version: u32

Schema version the client requires the daemon to report from /v1/health. Defaults to EXPECTED_SCHEMA_VERSION.

connect_timeout: Duration

Total budget for the auto-spawn connect poll (connect + spawn + retry). Defaults to 1 second.

poll_interval: Duration

Interval between socket-connect attempts while polling for the daemon. Defaults to 10ms.

spawn: Spawner

How to start the daemon when it is not running. Defaults to the real kindling serve --daemonize binary.

transport: Transport

Transport to reach the daemon. Defaults to Transport::default (UDS on Unix, TCP on Windows).

spawn_log_path: Option<PathBuf>

Override for the spawn-failure diagnostic log path. When None, effective_spawn_log_path uses ~/.kindling/spawn.log.

Implementations

impl ClientConfig

pub fn defaults() -> Result<Self>

Build a default config: ~/.kindling/kindling.sock, project root from the current directory, the compiled schema version, a 1s connect budget, a 10ms poll interval, and the real binary spawner.

Errors only if neither the kindling home nor the current directory can be determined.

pub fn effective_spawn_log_path(&self) -> Option<PathBuf>

Path for spawn-failure diagnostics (~/.kindling/spawn.log by default).

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.