Struct Upgrade 

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

Available on crate features http and std only.

Upgrade header, defined in RFC7230

The Upgrade header field is intended to provide a simple mechanism for transitioning from HTTP/1.1 to some other protocol on the same connection. A client MAY send a list of protocols in the Upgrade header field of a request to invite the server to switch to one or more of those protocols, in order of descending preference, before sending the final response. A server MAY ignore a received Upgrade header field if it wishes to continue using the current protocol on that connection. Upgrade cannot be used to insist on a protocol change.

ABNF

Upgrade          = 1#protocol

protocol         = protocol-name ["/" protocol-version]
protocol-name    = token
protocol-version = token

Example values

• HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11

Note

In practice, the Upgrade header is never that complicated. In most cases, it is only ever a single value, such as "websocket".

Examples

use rama_http_headers::Upgrade;

let ws = Upgrade::websocket();

Implementations

impl Upgrade

pub fn as_bytes(&self) -> &[u8]

impl Upgrade

pub fn websocket() -> Upgrade

Constructs an Upgrade: websocket header.

pub fn is_websocket(&self) -> bool

Returns true if this is an Upgrade: websocket header.

pub fn contains_websocket(&self) -> bool

Return whether the offered protocol list includes WebSocket.

Unlike Self::is_websocket, other protocols may also be offered.

Trait Implementations

impl AsRef<[u8]> for Upgrade

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Upgrade

fn clone(&self) -> Upgrade

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Upgrade

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

Formats the value using the given formatter.

impl HeaderDecode for Upgrade

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for Upgrade

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 PartialEq for Upgrade

fn eq(&self, other: &Upgrade) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Upgrade

impl TypedHeader for Upgrade

fn name() -> &'static HeaderName

The name of this header.