Struct ClientConfig 

pub struct ClientConfig {
    pub base_url: String,
    pub timeout: Duration,
    pub sse_idle_timeout: Duration,
    pub retry: RetryConfig,
    pub sse_reconnect: ReconnectConfig,
    pub require_tls: bool,
    pub internal_token_provider: Option<InternalTokenProvider>,
}

Base configuration for a generated REST client.

Fields

base_url: String

Base URL prefix (e.g., https://billing.internal). Combined with the base path declared in the projection trait.

timeout: Duration

Deadline applied to a single unary attempt — NOT to the whole logical call. A #[retryable] method may make up to retry.max_attempts attempts, so the worst-case wall-clock for a logical call is bounded by max_attempts × (timeout + retry.max_delay) (the per-retry backoff is itself clamped to RetryConfig::max_delay, including a server-advised Retry-After). There is deliberately no separate whole-call budget field.

sse_idle_timeout: Duration

Per-event idle deadline for SSE streams: the maximum gap between two received stream events before the stream is treated as timed out. A long-lived stream is NOT bounded by timeout (which would kill a healthy slow stream); it is bounded by this larger idle deadline instead. Defaults to 60s (> the unary default).

retry: RetryConfig

Retry policy applied to methods marked #[retryable].

sse_reconnect: ReconnectConfig

SSE-stream reconnect policy. By default max_attempts: 0 — stream failures bubble up unchanged. Set explicitly to opt into HTML5 EventSource-style Last-Event-ID reconnect.

require_tls: bool

When true, the generated client refuses plaintext http:// and requires TLS (toolkit_http::TransportSecurity::TlsOnly) for every request — including the bearer-carrying Authorization header, which otherwise would ride whatever scheme base_url uses. Defaults to false, preserving the platform’s existing in-mesh service-to-service convention where plaintext HTTP inside a secured network boundary is an accepted, deliberate choice (see build_default_http_client). Set this when a resolved endpoint may cross an untrusted network.

internal_token_provider: Option<InternalTokenProvider>

Source of the platform-plane internal credential attached to methods whose plane marker is PlatformSecurityContext (carried as X-ToolKit-Internal-Token). None (the default) attaches nothing — legitimate for Profile 1 / in-process (InternalCredential::None); the requirement is enforced server-side. The bootstrap layer populates this from the process’s selected InternalCredential. Tenant-plane methods (SecurityContext) never consult it; they forward the caller’s bearer token from the argument.

Implementations

impl ClientConfig

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

Create a new config with sensible defaults.

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

Override the per-call (unary) timeout.

pub fn with_sse_idle_timeout(self, idle: Duration) -> ClientConfig

Override the SSE per-event idle deadline (max gap between stream events).

pub fn with_retry(self, retry: RetryConfig) -> ClientConfig

Override the retry policy.

pub fn with_sse_reconnect(self, sse_reconnect: ReconnectConfig) -> ClientConfig

Override the SSE reconnect policy. Use ReconnectConfig::default() to disable (the default) or build a non-zero max_attempts policy to enable reconnect.

pub fn with_require_tls(self, require_tls: bool) -> ClientConfig

Require TLS (reject plaintext http://) for this client. See Self::require_tls.

pub fn with_internal_token_provider( self, provider: impl Into<Option<InternalTokenProvider>>, ) -> ClientConfig

Set (or clear) the platform-plane internal-credential provider. See Self::internal_token_provider. Accepts either an InternalTokenProvider or an Option<InternalTokenProvider>, so the bootstrap layer can pass through whatever the process selected without a branch.

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.