Struct Capabilities 

#[non_exhaustive]
pub struct Capabilities {
    pub client_pings: bool,
    pub sees_server_pings: bool,
    pub handshake_headers: bool,
}

What a SocketTransport can do.

A protocol reads it to choose how it keeps a connection alive: a transport that cannot send a ping frame gets an application-level ping, and one that never shows the server’s ping frames cannot count them as liveness.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_pings: bool

Whether the client can send ping and pong frames.

sees_server_pings: bool

Whether the server’s ping frames reach the reader as messages.

handshake_headers: bool

Whether the handshake request may carry headers beyond the ones the WebSocket protocol generates.

Informational: nothing in the tree reads it. A transport without it refuses a handshake header with Kind::Unsupported when it dials.

Implementations

impl Capabilities

pub const FULL: Capabilities

Every capability: what a native socket has.

pub const fn new( client_pings: bool, sees_server_pings: bool, handshake_headers: bool, ) -> Self

A transport’s capabilities.

Trait Implementations

impl Clone for Capabilities

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Capabilities

impl Debug for Capabilities

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

Formats the value using the given formatter.

impl Eq for Capabilities

impl PartialEq for Capabilities

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Capabilities