Struct Session

Source

pub struct Session { /* private fields */ }

Expand description

Session is a type that can carry settings over multiple requests. The settings applied to the Session are applied to every request created from this Session.

Session can be cloned cheaply and sent to other threads as it uses std::sync::Arc internally.

Implementations§

Source §

impl Session

Source

pub fn new() -> Session

Create a new Session with default settings.

Source

pub fn get(&self, base_url: U) -> RequestBuilder
where U: AsRef<str>,

Create a new RequestBuilder with the GET method and this Session’s settings applied on it.

Source

pub fn post(&self, base_url: U) -> RequestBuilder
where U: AsRef<str>,

Create a new RequestBuilder with the POST method and this Session’s settings applied on it.

Source

pub fn put(&self, base_url: U) -> RequestBuilder
where U: AsRef<str>,

Create a new RequestBuilder with the PUT method and this Session’s settings applied on it.

Source

pub fn delete(&self, base_url: U) -> RequestBuilder
where U: AsRef<str>,

Create a new RequestBuilder with the DELETE method and this Session’s settings applied on it.

Source

pub fn head(&self, base_url: U) -> RequestBuilder
where U: AsRef<str>,

Create a new RequestBuilder with the HEAD method and this Session’s settings applied on it.

Source

pub fn options(&self, base_url: U) -> RequestBuilder
where U: AsRef<str>,

Create a new RequestBuilder with the OPTIONS method and this Session’s settings applied on it.

Source

pub fn patch(&self, base_url: U) -> RequestBuilder
where U: AsRef<str>,

Create a new RequestBuilder with the PATCH method and this Session’s settings applied on it.

Source

pub fn trace(&self, base_url: U) -> RequestBuilder
where U: AsRef<str>,

Create a new RequestBuilder with the TRACE method and this Session’s settings applied on it.

Modify a header for this Session.

If the header is already present, the value will be replaced. If you wish to append a new header, use header_append.

§Panics

This method will panic if the value is invalid.

Source

pub fn header_append<H, V>(&mut self, header: H, value: V)
where H: IntoHeaderName, V: TryInto<HeaderValue>, Error: From<V::Error>,

Append a new header for this Session.

The new header is always appended to the headers, even if the header already exists.

§Panics

This method will panic if the value is invalid.

Source

pub fn try_header<H, V>(&mut self, header: H, value: V) -> Result<()>
where H: IntoHeaderName, V: TryInto<HeaderValue>, Error: From<V::Error>,

Modify a header for this Session.

If the header is already present, the value will be replaced. If you wish to append a new header, use header_append.

Source

pub fn try_header_append<H, V>(&mut self, header: H, value: V) -> Result<()>
where H: IntoHeaderName, V: TryInto<HeaderValue>, Error: From<V::Error>,

Append a new header to this Session.

The new header is always appended to the headers, even if the header already exists.

Source

pub fn max_headers(&mut self, max_headers: usize)

Set the maximum number of headers accepted in responses to requests created from this Session.

The default is 100.

Source

pub fn max_redirections(&mut self, max_redirections: u32)

Set the maximum number of redirections the requests created from this Session can perform.

The default is 5.

Source

pub fn follow_redirects(&mut self, follow_redirects: bool)

Sets if requests created from this Session should follow redirects, 3xx codes.

This value defaults to true.

Source

pub fn connect_timeout(&mut self, connect_timeout: Duration)

Sets a connect timeout for requests created from this Session.

The default is 30 seconds.

Source

pub fn read_timeout(&mut self, read_timeout: Duration)

Sets a read timeout for requests created from this Session.

The default is 30 seconds.

Source

pub fn timeout(&mut self, timeout: Duration)

Sets a timeout for the maximum duration of requests created from this Session.

Applies after a TCP connection is established. Defaults to no timeout.

Source

pub fn proxy_settings(&mut self, proxy_settings: ProxySettings)

Sets the proxy settigns for requests created from this Session.

If left untouched, the defaults are to use system proxy settings found in environment variables.

Source

pub fn default_charset(&mut self, default_charset: Option<Charset>)

Set the default charset to use while parsing the responses of requests created from this Session.

If the response does not say which charset it uses, this charset will be used to decode the requests. This value defaults to None, in which case ISO-8859-1 is used.

Source

pub fn allow_compression(&mut self, allow_compression: bool)

Sets if requests created from this Session will announce that they accept compression.

This value defaults to true. Note that this only lets the browser know that the requests support compression, the server might choose not to compress the content.

Source

pub fn danger_accept_invalid_certs(&mut self, accept_invalid_certs: bool)

Sets if requests created from this Session will accept invalid TLS certificates.

Accepting invalid certificates implies that invalid hostnames are accepted as well.

The default value is false.

§Danger

Use this setting with care. This will accept any TLS certificate valid or not. If you are using self signed certificates, it is much safer to add their root CA to the list of trusted root CAs by your system.

Source