Struct CachekitIOBuilder 

pub struct CachekitIOBuilder { /* private fields */ }

Builder for CachekitIO.

Implementations

impl CachekitIOBuilder

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

Set the API key (required).

pub fn api_url(self, url: impl Into<String>) -> Self

Override the API base URL (default: https://api.cachekit.io).

pub fn allow_custom_host(self, allow: bool) -> Self

Allow non-standard hostnames (e.g. custom proxies). Private IPs are still blocked.

pub fn metrics_provider(self, provider: MetricsProvider) -> Self

Override the source of the X-CacheKit-* telemetry headers.

Not needed for normal use: CacheKitBuilder::build attaches the client’s own live counters to any backend without one. Set this only to report numbers from somewhere else; it takes precedence.

pub fn build(self) -> Result<CachekitIO, CachekitError>

Consume the builder and construct a CachekitIO.

Errors

Returns an error if:

• api_key was not set.
• the resolved URL scheme is not https.
• the URL hostname is not permitted (see validate_cachekitio_url).

Trait Implementations

impl Default for CachekitIOBuilder

fn default() -> Self

Returns the “default value” for a type.