Struct Config

#[non_exhaustive]
pub struct Config {
    pub base_url: Option<Url>,
    pub headers: HashMap<HeaderName, HeaderValues>,
}

Configuration for crux_http::Https and their underlying HTTP client.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

base_url: Option<Url>

The base URL for a client. All request URLs will be relative to this URL.

Note: a trailing slash is significant. Without it, the last path component is considered to be a “file” name to be removed to get at the “directory” that is used as the base.

headers: HashMap<HeaderName, HeaderValues>

Headers to be applied to every request made by this client.

Implementations

impl Config

pub fn new() -> Self

Construct new empty config.

impl Config

pub fn add_header( self, name: impl Into<HeaderName>, values: impl ToHeaderValues, ) -> Result<Self>

Adds a header to be added to every request by this config.

Default: No extra headers.

pub fn set_base_url(self, base: Url) -> Self

Sets the base URL for this config. All request URLs will be relative to this URL.

Note: a trailing slash is significant. Without it, the last path component is considered to be a “file” name to be removed to get at the “directory” that is used as the base.

Default: None (internally).

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.