Struct soket::connection::Builder

pub struct Builder<T> { /* fields omitted */ }

A connection builder.

Allows configuring certain parameters and extensions before creating the Sender/Receiver pair that represents the connection.

Implementations

impl<T: AsyncRead + AsyncWrite + Unpin> Builder<T>

pub fn new(socket: T, mode: Mode) -> Self

Create a new Builder from the given async I/O resource and mode.

Note: Use this type only after a successful handshake. You can either use this crate’s handshake functionality or perform the handshake by some other means.

pub fn set_buffer(&mut self, b: BytesMut)

Set a custom buffer to use.

pub fn add_extensions<I>(&mut self, extensions: I) where
    I: IntoIterator<Item = Box<dyn Extension + Send>>, 

Add extensions to use with this connection.

Only enabled extensions will be considered.

pub fn set_max_message_size(&mut self, max: usize)

Set the maximum size of a complete message.

Message fragments will be buffered and concatenated up to this value, i.e. the sum of all message frames payload lengths will not be greater than this maximum. However, extensions may increase the total message size further, e.g. by decompressing the payload data.

pub fn set_max_frame_size(&mut self, max: usize)

Set the maximum size of a single websocket frame payload.

pub fn finish(self) -> (Sender<T>, Receiver<T>)

Create a configured Sender/Receiver pair.

Trait Implementations

impl<T: Debug> Debug for Builder<T>

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

Formats the value using the given formatter.