Skip to main content

CurlConfig

Struct CurlConfig 

Source
pub struct CurlConfig {
    pub connect_timeout: Duration,
    pub total_timeout: Duration,
    pub max_redirects: usize,
    pub follow_redirects: bool,
    pub allowed_protocols: Vec<String>,
    pub proxy: CurlProxy,
}
Expand description

Strict transport configuration. All policy lives here.

Fields§

§connect_timeout: Duration

Connect deadline ceiling.

§total_timeout: Duration

Total deadline ceiling.

§max_redirects: usize

Redirect bound when following is enabled.

§follow_redirects: bool

Whether HTTP redirects are followed.

§allowed_protocols: Vec<String>

Allowed URL protocols (default http, https).

This list bounds the initial request. The redirect target set is narrowed further: an https request never follows a redirect down to http, so a 302 Location: http://... is refused rather than followed in cleartext.

§proxy: CurlProxy

Proxy routing decision.

Implementations§

Source§

impl CurlConfig

Source

pub fn strict() -> Self

Strict default: bounded timeouts, redirect bound, explicit proxy.

Examples found in repository?
examples/curl_fetch.rs (line 14)
11fn main() {
12    let exe = discover_curl_executable().unwrap_or_else(|_| "/usr/bin/curl".into());
13    let transport =
14        CurlTransport::with_executable(exe, CurlConfig::strict()).expect("curl transport");
15    let request = AcquisitionRequest::new("https://example.com/artifact").expect("request");
16    println!("curl executable: {}", transport.executable().display());
17    println!("request: {}", request.redacted());
18    println!("limits: {:?}", FetchLimits::default());
19}
Source

pub fn timeouts(self, connect: Duration, total: Duration) -> Self

Sets connect/total adapter ceilings.

These are ceilings, not defaults: the effective deadline for one fetch is min(request, adapter ceiling) (see FetchLimits::effective).

Source

pub fn max_redirects(self, max: usize) -> Self

Sets the redirect bound.

Source

pub fn follow_redirects(self, follow: bool) -> Self

Sets whether redirects are followed.

Source

pub fn allowed_protocols(self, protocols: Vec<String>) -> Self

Sets the allowed protocols.

Source

pub fn proxy(self, proxy: CurlProxy) -> Self

Sets the proxy decision.

Source

pub fn effective_timeouts(&self, limits: FetchLimits) -> (Duration, Duration)

Derives the authoritative effective deadlines for one fetch.

Trait Implementations§

Source§

impl Clone for CurlConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CurlConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CurlConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.