Struct SecWebSocketProtocol 

pub struct SecWebSocketProtocol(pub NonEmptySmallVec<3, NonEmptyStr>);

The Sec-WebSocket-Protocol header, containing one or multiple protocols.

Sub protocols are advertised by the client, and the server has to match it if defined.

Tuple Fields

0: NonEmptySmallVec<3, NonEmptyStr>

Implementations

impl SecWebSocketProtocol

pub fn new(value: NonEmptyStr) -> Self

impl SecWebSocketProtocol

pub fn accept_first_protocol(&self) -> AcceptedWebSocketProtocol

Return the first protocol in this SecWebSocketProtocol as the AcceptedWebSocketProtocol.

pub fn contains( &self, protocol: impl AsRef<str>, ) -> Option<AcceptedWebSocketProtocol>

returns true if the given protocol is found in this SecWebSocketProtocol

pub fn contains_any( &self, protocols: impl IntoIterator<Item: AsRef<str>>, ) -> Option<AcceptedWebSocketProtocol>

returns true if any of the given protocol is found in this SecWebSocketProtocol

Searched in order.

pub fn iter(&self) -> impl Iterator<Item = &str>

Trait Implementations

impl Clone for SecWebSocketProtocol

fn clone(&self) -> SecWebSocketProtocol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecWebSocketProtocol

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

Formats the value using the given formatter.

impl Eq for SecWebSocketProtocol

impl From<AcceptedWebSocketProtocol> for SecWebSocketProtocol

fn from(value: AcceptedWebSocketProtocol) -> Self

Converts to this type from the input type.

impl HeaderDecode for SecWebSocketProtocol

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for SecWebSocketProtocol

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

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 SecWebSocketProtocol

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SecWebSocketProtocol

impl TypedHeader for SecWebSocketProtocol

fn name() -> &'static HeaderName

The name of this header.