Struct Protocol 

pub struct Protocol { /* private fields */ }

Available on crate features http-backend and http and std only.

The Protocol extension carries the value of the :protocol pseudo-header used by the Extended CONNECT Protocol.

It is shared by HTTP/2 (RFC 8441) and HTTP/3 (RFC 9220): both carry the same :protocol pseudo-header, most commonly with the value websocket.

The value is a validated, non-empty HTTP token (RFC 9110 §5.6.2). Every construction path enforces that invariant, so a Protocol can never hold an empty or non-token value that would be illegal on the wire.

Example

use rama_core::extensions::ExtensionsRef;
use rama_http_types::proto::h2::ext::Protocol;
use rama_http_types::{Request, Method, Version};

let mut req = Request::new(());
*req.method_mut() = Method::CONNECT;
*req.version_mut() = Version::HTTP_2;
req.extensions().insert(Protocol::WEBSOCKET);
// Now the request will include the `:protocol` pseudo-header with value "websocket"

Implementations

impl Protocol

pub const WEBSOCKET: Protocol

websocket, the token registered by RFC 8441 for the WebSocket Protocol.

It is used for Extended CONNECT over both HTTP/2 (RFC 8441) and HTTP/3 (RFC 9220).

pub const fn from_static(value: &'static str) -> Protocol

Converts a static string to a protocol name.

Panics

Panics if value is not a non-empty HTTP token. Because a :protocol value that is not a token cannot be sent on the wire, an invalid literal is a programming error rather than a runtime condition.

pub fn as_str(&self) -> &str

Returns a str representation of the header.

pub fn try_from_bytes(bytes: Bytes) -> Result<Protocol, InvalidProtocol>

Parses a :protocol value from raw wire bytes, validating that it is a non-empty token.

Trait Implementations

impl AsRef<[u8]> for Protocol

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

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

impl Clone for Protocol

fn clone(&self) -> Protocol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Protocol

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

Formats the value using the given formatter.

impl Eq for Protocol

impl Extension for Protocol

impl HttpExtension for Protocol

impl PartialEq for Protocol

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Protocol

impl<'a> TryFrom<&'a str> for Protocol

type Error = InvalidProtocol

The type returned in the event of a conversion error.

fn try_from( value: &'a str, ) -> Result<Protocol, <Protocol as TryFrom<&'a str>>::Error>

Performs the conversion.

impl TryFrom<Bytes> for Protocol

type Error = InvalidProtocol

The type returned in the event of a conversion error.

fn try_from( bytes: Bytes, ) -> Result<Protocol, <Protocol as TryFrom<Bytes>>::Error>

Performs the conversion.