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
.
Implementations
sourceimpl Session
impl Session
sourcepub fn get<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
pub fn get<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
Create a new RequestBuilder
with the GET method and this Session’s settings applied on it.
sourcepub fn post<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
pub fn post<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
Create a new RequestBuilder
with the POST method and this Session’s settings applied on it.
sourcepub fn put<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
pub fn put<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
Create a new RequestBuilder
with the PUT method and this Session’s settings applied on it.
sourcepub fn delete<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
pub fn delete<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
Create a new RequestBuilder
with the DELETE method and this Session’s settings applied on it.
sourcepub fn head<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
pub fn head<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
Create a new RequestBuilder
with the HEAD method and this Session’s settings applied on it.
sourcepub fn options<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
pub fn options<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
Create a new RequestBuilder
with the OPTIONS method and this Session’s settings applied on it.
sourcepub fn patch<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
pub fn patch<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
Create a new RequestBuilder
with the PATCH method and this Session’s settings applied on it.
sourcepub fn trace<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
pub fn trace<U>(&self, base_url: U) -> RequestBuilderwhere
U: AsRef<str>,
Create a new RequestBuilder
with the TRACE method and this Session’s settings applied on it.
sourcepub fn header<H, V>(&mut self, header: H, value: V)where
H: IntoHeaderName,
V: TryInto<HeaderValue>,
Error: From<V::Error>,
pub fn header<H, V>(&mut self, header: H, value: V)where
H: IntoHeaderName,
V: TryInto<HeaderValue>,
Error: From<V::Error>,
Modify a header for this Request
.
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.
sourcepub fn header_append<H, V>(&mut self, header: H, value: V)where
H: IntoHeaderName,
V: TryInto<HeaderValue>,
Error: From<V::Error>,
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 Request
.
The new header is always appended to the request, even if the header already exists.
Panics
This method will panic if the value is invalid.
sourcepub fn try_header<H, V>(&mut self, header: H, value: V) -> Result<()>where
H: IntoHeaderName,
V: TryInto<HeaderValue>,
Error: From<V::Error>,
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 Request
.
If the header is already present, the value will be replaced. If you wish to append a new header,
use header_append
.
sourcepub fn try_header_append<H, V>(&mut self, header: H, value: V) -> Result<()>where
H: IntoHeaderName,
V: TryInto<HeaderValue>,
Error: From<V::Error>,
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 Request
.
The new header is always appended to the Request
, even if the header already exists.
sourcepub fn max_headers(&mut self, max_headers: usize)
pub fn max_headers(&mut self, max_headers: usize)
Set the maximum number of headers accepted in responses to this request.
The default is 100.
sourcepub fn max_redirections(&mut self, max_redirections: u32)
pub fn max_redirections(&mut self, max_redirections: u32)
Set the maximum number of redirections this Request
can perform.
The default is 5.
sourcepub fn follow_redirects(&mut self, follow_redirects: bool)
pub fn follow_redirects(&mut self, follow_redirects: bool)
Sets if this Request
should follow redirects, 3xx codes.
This value defaults to true.
sourcepub fn connect_timeout(&mut self, duration: Duration)
pub fn connect_timeout(&mut self, duration: Duration)
Sets a connect timeout for this request.
The default is 30 seconds.
sourcepub fn read_timeout(&mut self, duration: Duration)
pub fn read_timeout(&mut self, duration: Duration)
Sets a read timeout for this request.
The default is 30 seconds.
sourcepub fn timeout(&mut self, duration: Duration)
pub fn timeout(&mut self, duration: Duration)
Sets a timeout for the whole request.
Applies after a TCP connection is established. Defaults to no timeout.
sourcepub fn proxy_settings(&mut self, settings: ProxySettings)
pub fn proxy_settings(&mut self, settings: ProxySettings)
Sets the proxy settigns for this request.
If left untouched, the defaults are to use system proxy settings found in environment variables.
sourcepub fn default_charset(&mut self, default_charset: Option<Charset>)
pub fn default_charset(&mut self, default_charset: Option<Charset>)
Set the default charset to use while parsing the response of this Request
.
If the response does not say which charset it uses, this charset will be used to decode the request.
This value defaults to None
, in which case ISO-8859-1 is used.
sourcepub fn allow_compression(&mut self, allow_compression: bool)
pub fn allow_compression(&mut self, allow_compression: bool)
Sets if this Request
will announce that it accepts compression.
This value defaults to true. Note that this only lets the browser know that this Request
supports
compression, the server might choose not to compress the content.
sourcepub fn danger_accept_invalid_certs(&mut self, accept_invalid_certs: bool)
pub fn danger_accept_invalid_certs(&mut self, accept_invalid_certs: bool)
Sets if this Request
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.
sourcepub fn danger_accept_invalid_hostnames(&mut self, accept_invalid_hostnames: bool)
pub fn danger_accept_invalid_hostnames(&mut self, accept_invalid_hostnames: bool)
Sets if this Request
will accept an invalid hostname in a TLS certificate.
The default value is false
.
Danger
Use this setting with care. This will accept TLS certificates that do not match the hostname.
sourcepub fn add_root_certificate(&mut self, cert: Certificate)
pub fn add_root_certificate(&mut self, cert: Certificate)
Adds a root certificate that will be trusted.