Struct Connection 

pub struct Connection(/* private fields */);

Available on crate feature http only.

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`
* `keep-alive, upgrade`

Examples

use rama_http_headers::Connection;

let keep_alive = Connection::keep_alive();

Implementations

impl Connection

pub fn iter_headers(&self) -> impl Iterator<Item = &HeaderName>

impl Connection

pub fn open(headers: NonEmptyVec<HeaderName>) -> Connection

A constructor to easily create a Connection header, for the given header names.

pub fn close() -> Connection

A constructor to easily create a Connection: close header.

pub fn is_close(&self) -> bool

Returns true if this Connection header contains close.

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_header(&self, name: impl PartialEq<HeaderName>) -> bool

Returns true if this Connection header contains the given header.

Example

use rama_http_types::header::UPGRADE;
use rama_http_headers::Connection;

let conn = Connection::keep_alive();

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

pub fn contains_upgrade(&self) -> bool

Returns true if this Connection header contains Upgrade.

Example

use rama_http_headers::Connection;

assert!(!Connection::keep_alive().contains_upgrade());
assert!(Connection::upgrade().contains_upgrade());

pub fn contains_keep_alive(&self) -> bool

Returns true if this Connection header contains Keep-Alive.

Example

use rama_http_headers::Connection;

assert!(Connection::keep_alive().contains_keep_alive());
assert!(!Connection::upgrade().contains_keep_alive());

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl HeaderDecode for Connection

fn decode<'i, I>(values: &mut I) -> Result<Connection, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for Connection

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

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> Option<HeaderValue>

Encode this header to HeaderValue.

impl TypedHeader for Connection

fn name() -> &'static HeaderName

The name of this header.