Skip to main content

HttpConfig

Struct HttpConfig 

Source
pub struct HttpConfig {
    pub tls_verify: bool,
    pub tls_cacerts: Option<TlsCacerts>,
    pub user_agent: Option<String>,
    pub timeout: Option<f64>,
}
Expand description

Sphinx’s shared HTTP configuration group plus intersphinx_timeout (ext/intersphinx/_load.py:211-227, _InvConfig).

Fields§

§tls_verify: bool§tls_cacerts: Option<TlsCacerts>§user_agent: Option<String>§timeout: Option<f64>

Seconds. None is Sphinx’s default and means no timeout — the value is handed to requests as timeout=None (ext/intersphinx/__init__.py:70-72).

Implementations§

Source§

impl HttpConfig

Source

pub fn user_agent(&self) -> &str

headers.setdefault('User-Agent', _user_agent or _USER_AGENT) (util/requests.py:96-97): an empty configured value is falsy in Python and so also falls back to the default.

Source

pub fn timeout_duration(&self) -> Option<Duration>

timeout as a Duration, or None for “no timeout” — which is both Sphinx’s default and what an unusable value degrades to.

intersphinx_timeout arrives from conf.py as an unvalidated f64, and Duration::from_secs_f64 panics on a negative, NaN or overflowing one. intersphinx_timeout = -1 is a natural thing to write (intersphinx_cache_limit = -1 is the documented Sphinx idiom for “never expire”), and with panic = "abort" in the release profile that panic is a bare SIGABRT naming neither the config key nor the file. Sphinx wraps the whole fetch in except Exception (ext/intersphinx/_load.py:302-313), so a bad value there is one entry in failures and the build carries on; this degrades the same way, and says which value it rejected.

Source

pub fn ca_bundle_for(&self, url: &str) -> Option<&str>

_get_tls_cacert(url, tls_cacerts) (util/requests.py:34-45): a plain string is the bundle for every URL; a mapping is keyed by the URL’s netloc with userinfo stripped, and a host it does not name falls back to the default trust store.

Trait Implementations§

Source§

impl Clone for HttpConfig

Source§

fn clone(&self) -> HttpConfig

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 HttpConfig

Source§

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

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

impl Default for HttpConfig

Hand-written rather than derived: bool::default() is false, and a default that silently turns off certificate verification is not a default anyone should be able to reach by accident. Sphinx’s tls_verify default is True (config.py:286), and so is this one.

Source§

fn default() -> Self

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

impl PartialEq for HttpConfig

Source§

fn eq(&self, other: &HttpConfig) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for HttpConfig

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.