Skip to main content

Module client

Module client 

Source
Expand description

The client: what a caller holds, clones and shares.

A client owns its transport and is cheap to clone, so passing one to every task is the intended use rather than something to work around with a shared reference. The API key enters as a secret and is kept only as the finished Authorization header value, marked sensitive, so no formatting of the client or its configuration can print it.

The key is copied once into the Authorization header value, which is not zeroed and lives as long as the client and every request built from it; HeaderValue is Bytes-backed and shared by reference count, so it cannot be zeroed on drop.

Structsยง

Client
A client of the TypeSafe API.
ClientBuilder
Configures a Client.