Struct headers::Connection

pub struct Connection(_);

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

impl Connection

pub fn close() -> Connection

A constructor to easily create a Connection: close header.

pub fn keep_alive() -> Connection

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

pub fn upgrade() -> Connection

A constructor to easily create a Connection: Upgrade header.

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

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Connection

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

Formats the value using the given formatter.

impl FromIterator<HeaderName> for Connection

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

Creates a value from an iterator.

impl Header for Connection

fn name() -> &'static HeaderName

The name of this header.

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

Decode this type from an iterator of HeaderValues.

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

Encode this type to a HeaderMap.