[−][src]Struct chttp::options::Options

pub struct Options {
    pub redirect_policy: RedirectPolicy,
    pub preferred_http_version: Option<Version>,
    pub timeout: Option<Duration>,
    pub connect_timeout: Duration,
    pub tcp_keepalive: Option<Duration>,
    pub tcp_nodelay: bool,
    pub buffer_size: usize,
    pub auto_referer: bool,
    pub proxy: Option<Uri>,
    pub max_upload_speed: Option<u64>,
    pub max_download_speed: Option<u64>,
}

Defines various protocol and connection options.

Fields

redirect_policy: RedirectPolicy

The policy for automatically following server redirects.

The default is to not follow redirects.

preferred_http_version: Option<Version>

A preferred HTTP version the client should attempt to use to communicate to the server with.

This is treated as a suggestion. A different version may be used if the server does not support it or negotiates a different version.

The default value is None (any version).

timeout: Option<Duration>

A timeout for the maximum time allowed for a request-response cycle.

The default value is None (unlimited).

connect_timeout: Duration

A timeout for the initial connection phase.

The default value is 300 seconds.

tcp_keepalive: Option<Duration>

Enable or disable TCP keepalive with a given probe interval.

The default value is None (disabled).

tcp_nodelay: bool

Enable or disable the TCP_NODELAY option.

The default value is false.

buffer_size: usize

Set the max buffer size in bytes to use for reading the response body.

The default value is 8 KiB.

auto_referer: bool

Indicates whether the Referer header should be automatically updated.

proxy: Option<Uri>

A proxy to use for requests.

The proxy protocol is specified by the URI scheme.

http: Proxy. Default when no scheme is specified.
https: HTTPS Proxy. (Added in 7.52.0 for OpenSSL, GnuTLS and NSS)
socks4: SOCKS4 Proxy.
socks4a: SOCKS4a Proxy. Proxy resolves URL hostname.
socks5: SOCKS5 Proxy.
socks5h: SOCKS5 Proxy. Proxy resolves URL hostname.

max_upload_speed: Option<u64>

A maximum upload speed for the request body, in bytes per second.

The default is unlimited.

max_download_speed: Option<u64>

A maximum download speed for the response body, in bytes per second.

The default is unlimited.

Methods

`impl Options`[src]

`pub fn with_redirect_policy(self, value: RedirectPolicy) -> Self`[src]

Sets the #name property.

`pub fn with_preferred_http_version(self, value: Option<Version>) -> Self`[src]

Sets the #name property.

`pub fn with_timeout(self, value: Option<Duration>) -> Self`[src]

Sets the #name property.

`pub fn with_connect_timeout(self, value: Duration) -> Self`[src]

Sets the #name property.

`pub fn with_tcp_keepalive(self, value: Option<Duration>) -> Self`[src]

Sets the #name property.

`pub fn with_tcp_nodelay(self, value: bool) -> Self`[src]

Sets the #name property.

`pub fn with_buffer_size(self, value: usize) -> Self`[src]

Sets the #name property.

`pub fn with_auto_referer(self, value: bool) -> Self`[src]

Sets the #name property.

`pub fn with_proxy(self, value: Option<Uri>) -> Self`[src]

Sets the #name property.

`pub fn with_max_upload_speed(self, value: Option<u64>) -> Self`[src]

Sets the #name property.

`pub fn with_max_download_speed(self, value: Option<u64>) -> Self`[src]

Sets the #name property.

Trait Implementations

`impl Default for Options`[src]

`fn default() -> Self`[src]

Create a new options with the default values.

`impl Clone for Options`[src]

`fn clone(&self) -> Options`[src]

`fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from source. Read more

`impl Debug for Options`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

Auto Trait Implementations

`impl Send for Options`

`impl Sync for Options`

Blanket Implementations

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> From for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T> Borrow for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> BorrowMut for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

[−][src]Struct chttp::options::Options

Fields

Methods

impl Options[src]

pub fn with_redirect_policy(self, value: RedirectPolicy) -> Self[src]

pub fn with_preferred_http_version(self, value: Option<Version>) -> Self[src]

pub fn with_timeout(self, value: Option<Duration>) -> Self[src]

pub fn with_connect_timeout(self, value: Duration) -> Self[src]

pub fn with_tcp_keepalive(self, value: Option<Duration>) -> Self[src]

pub fn with_tcp_nodelay(self, value: bool) -> Self[src]

pub fn with_buffer_size(self, value: usize) -> Self[src]

pub fn with_auto_referer(self, value: bool) -> Self[src]

pub fn with_proxy(self, value: Option<Uri>) -> Self[src]

pub fn with_max_upload_speed(self, value: Option<u64>) -> Self[src]

pub fn with_max_download_speed(self, value: Option<u64>) -> Self[src]

Trait Implementations

impl Default for Options[src]

fn default() -> Self[src]

impl Clone for Options[src]

fn clone(&self) -> Options[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Options[src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

Auto Trait Implementations

impl Send for Options

impl Sync for Options

Blanket Implementations

impl<T, U> Into for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T> From for T[src]

fn from(t: T) -> T[src]

impl<T, U> TryFrom for T where U: Into<T>, [src]

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T> Borrow for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

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

fn type_id(&self) -> TypeId[src]

impl<T> BorrowMut for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

impl<T, U> TryInto for T where U: TryFrom<T>, [src]

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

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

impl<T> Erased for T

`impl Options`[src]

`pub fn with_redirect_policy(self, value: RedirectPolicy) -> Self`[src]

`pub fn with_preferred_http_version(self, value: Option<Version>) -> Self`[src]

`pub fn with_timeout(self, value: Option<Duration>) -> Self`[src]

`pub fn with_connect_timeout(self, value: Duration) -> Self`[src]

`pub fn with_tcp_keepalive(self, value: Option<Duration>) -> Self`[src]

`pub fn with_tcp_nodelay(self, value: bool) -> Self`[src]

`pub fn with_buffer_size(self, value: usize) -> Self`[src]

`pub fn with_auto_referer(self, value: bool) -> Self`[src]

`pub fn with_proxy(self, value: Option<Uri>) -> Self`[src]

`pub fn with_max_upload_speed(self, value: Option<u64>) -> Self`[src]

`pub fn with_max_download_speed(self, value: Option<u64>) -> Self`[src]

`impl Default for Options`[src]

`fn default() -> Self`[src]

`impl Clone for Options`[src]

`fn clone(&self) -> Options`[src]

`fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

`impl Debug for Options`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Send for Options`

`impl Sync for Options`

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> From for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T> Borrow for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> BorrowMut for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

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

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

`impl<T> Erased for T`