Struct Connection

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

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 rama_http_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 contains_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 contains_keep_alive(&self) -> bool

Returns true if this Connection header contains keep-alive.

pub fn upgrade() -> Connection

A constructor to easily create a Connection: Upgrade header.

pub fn contains_upgrade(&self) -> bool

Returns true if this Connection header contains Upgrade.

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

use rama_http_types::header::UPGRADE;
use rama_http_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 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 FromIterator<HeaderName> for Connection

fn from_iter<I>(iter: I) -> Connection

where I: IntoIterator<Item = HeaderName>,

Creates a value from an iterator.

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) -> HeaderValue

Encode this header to HeaderValue.

impl TypedHeader for Connection

fn name() -> &'static HeaderName

The name of this header.