Struct websocket::header::WebSocketProtocol

pub struct WebSocketProtocol(pub Vec<String>);

Represents a Sec-WebSocket-Protocol header

Methods from Deref<Target = Vec<String>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector’s buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn allocator(&self) -> &A

🔬 This is a nightly-only experimental API. (allocator_api)

Returns a reference to the underlying allocator.

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its ‘length’.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl Clone for WebSocketProtocol

fn clone(&self) -> WebSocketProtocol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketProtocol

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

Formats the value using the given formatter.

impl Deref for WebSocketProtocol

type Target = Vec<String>

The resulting type after dereferencing.

fn deref(&self) -> &Vec<String>

Dereferences the value.

impl Display for WebSocketProtocol

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

Formats the value using the given formatter.

impl Header for WebSocketProtocol

fn header_name() -> &'static str

Returns the name of the header field this belongs to.

fn parse_header(raw: &[Vec<u8>]) -> Result<WebSocketProtocol>

Parse a header from a raw stream of bytes.

impl HeaderFormat for WebSocketProtocol

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

Format a header to be output into a TcpStream.

impl PartialEq<WebSocketProtocol> for WebSocketProtocol

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for WebSocketProtocol