Struct headers::Connection

source ·
pub struct Connection(/* private fields */);
Expand description

Connection header, defined in RFC7230

The Connection header field allows the sender to indicate desired control options for the current connection. In order to avoid confusing downstream recipients, a proxy or gateway MUST remove or replace any received connection options before forwarding the message.

§ABNF

Connection        = 1#connection-option
connection-option = token

# Example values
* `close`
* `keep-alive`
* `upgrade`

§Examples

use headers::Connection;

let keep_alive = Connection::keep_alive();

Implementations§

source§

impl Connection

source

pub fn close() -> Connection

A constructor to easily create a Connection: close header.

source

pub fn keep_alive() -> Connection

A constructor to easily create a Connection: keep-alive header.

source

pub fn upgrade() -> Connection

A constructor to easily create a Connection: Upgrade header.

source

pub fn contains(&self, name: impl AsConnectionOption) -> bool

Check if this header contains a given “connection option”.

This can be used with various argument types:

  • &str
  • &HeaderName
  • HeaderName
§Example
extern crate http;

use http::header::UPGRADE;
use headers::Connection;

let conn = Connection::keep_alive();

assert!(!conn.contains("close"));
assert!(!conn.contains(UPGRADE));
assert!(conn.contains("keep-alive"));
assert!(conn.contains("Keep-Alive"));

Trait Implementations§

source§

impl Clone for Connection

source§

fn clone(&self) -> Connection

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Connection

source§

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

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

impl FromIterator<HeaderName> for Connection

source§

fn from_iter<I>(iter: I) -> Self
where I: IntoIterator<Item = HeaderName>,

Creates a value from an iterator. Read more
source§

impl Header for Connection

source§

fn name() -> &'static HeaderName

The name of this header.
source§

fn decode<'i, I>(values: &mut I) -> Result<Self, Error>
where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.
source§

fn encode<E: Extend<HeaderValue>>(&self, values: &mut E)

Encode this type to a HeaderMap. 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§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

type Error = Infallible

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

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

Performs the conversion.
source§

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

§

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.