Struct SecWebSocketProtocol

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

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.

Implementations

impl SecWebSocketProtocol

pub fn new(protocol: impl Into<Arc<str>>) -> SecWebSocketProtocol

Create a new SecWebSocketProtocol header from the given protocol

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 [SubProtocols]

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

where <impl IntoIterator as IntoIterator>::Item: AsRef<str>,

returns true if any of the given protocol is found in this [SubProtocols]

Searched in order.

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

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

pub fn with_additional_protocol( self, protocol: impl Into<Arc<str>>, ) -> SecWebSocketProtocol

Add the WebSocket protocol, appending it to any existing protocol(s).

pub fn set_additional_protocol( &mut self, protocol: impl Into<Arc<str>>, ) -> &mut SecWebSocketProtocol

Add the WebSocket protocol, appending it to any existing protocol(s).

pub fn with_additional_protocols( self, protocols: impl IntoIterator<Item = impl Into<Arc<str>>>, ) -> SecWebSocketProtocol

Add the WebSocket protocols, appending it to any existing protocol(s).

pub fn set_additional_protocols( &mut self, protocols: impl IntoIterator<Item = impl Into<Arc<str>>>, ) -> &mut SecWebSocketProtocol

Add the WebSocket protocols, appending it to any existing protocol(s).

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

Formats the value using the given formatter.

impl From<AcceptedWebSocketProtocol> for SecWebSocketProtocol

fn from(value: AcceptedWebSocketProtocol) -> SecWebSocketProtocol

Converts to this type from the input type.

impl HeaderDecode for SecWebSocketProtocol

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for SecWebSocketProtocol

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 IntoIterator for SecWebSocketProtocol

type Item = Arc<str>

The type of the elements being iterated over.

type IntoIter = IntoIter<Arc<str>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <SecWebSocketProtocol as IntoIterator>::IntoIter

Creates an iterator from a value.

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 TypedHeader for SecWebSocketProtocol

fn name() -> &'static HeaderName

The name of this header.

impl Eq for SecWebSocketProtocol

impl StructuralPartialEq for SecWebSocketProtocol