Struct oci_client::client::ClientConfig

pub struct ClientConfig {

    pub protocol: ClientProtocol,
    pub accept_invalid_certificates: bool,
    pub use_monolithic_push: bool,
    pub extra_root_certificates: Vec<Certificate>,
    pub platform_resolver: Option<Box<dyn Fn(&[ImageIndexEntry]) -> Option<String> + Send + Sync>>,
    pub max_concurrent_upload: usize,
    pub max_concurrent_download: usize,
    pub default_token_expiration_secs: usize,
    pub read_timeout: Option<Duration>,
    pub connect_timeout: Option<Duration>,
    pub user_agent: &'static str,
    pub https_proxy: Option<String>,
    pub no_proxy: Option<String>,
}

A client configuration

Fields

protocol: ClientProtocol

Which protocol the client should use

accept_invalid_certificates: bool

Accept invalid certificates. Defaults to false

use_monolithic_push: bool

Use monolithic push for pushing blobs. Defaults to false

extra_root_certificates: Vec<Certificate>

A list of extra root certificate to trust. This can be used to connect to servers using self-signed certificates

platform_resolver: Option<Box<dyn Fn(&[ImageIndexEntry]) -> Option<String> + Send + Sync>>

A function that defines the client’s behaviour if an Image Index Manifest (i.e Manifest List) is encountered when pulling an image. Defaults to current_platform_resolver, which attempts to choose an image matching the running OS and Arch.

If set to None, an error is raised if an Image Index manifest is received during an image pull.

max_concurrent_upload: usize

Maximum number of concurrent uploads to perform during a push operation.

This defaults to DEFAULT_MAX_CONCURRENT_UPLOAD.

max_concurrent_download: usize

Maximum number of concurrent downloads to perform during a pull operation.

This defaults to DEFAULT_MAX_CONCURRENT_DOWNLOAD.

default_token_expiration_secs: usize

Default token expiration in seconds, to use when the token claim doesn’t provide a value.

This defaults to DEFAULT_TOKEN_EXPIRATION_SECS.

read_timeout: Option<Duration>

Enables a read timeout for the client.

See reqwest::ClientBuilder::read_timeout for more information.

connect_timeout: Option<Duration>

Set a timeout for the connect phase for the client.

See reqwest::ClientBuilder::connect_timeout for more information.

user_agent: &'static str

Set the User-Agent used by the client.

This defaults to [DEFAULT_USER_AGENT].

https_proxy: Option<String>

Set the HTTPS PROXY used by the client.

This defaults to None.

no_proxy: Option<String>

Set the NO PROXY used by the client.

This defaults to None.

Trait Implementations

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<ClientConfig> for Client

type Error = OciDistributionError

The type returned in the event of a conversion error.

fn try_from(config: ClientConfig) -> Result<Self, Self::Error>

Performs the conversion.