pub struct DataFrameCodec<D> { /* private fields */ }
Expand description

A codec for decoding and encoding websocket dataframes.

This codec decodes dataframes into the crates default implementation of Dataframe but can encode and send any struct that implements the ws::Dataframe trait. The type of struct to encode is given by the D type parameter in the struct.

Using dataframes directly is meant for users who want low-level access to the connection. If you don’t want to do anything low-level please use the MessageCodec codec instead, or better yet use the ClientBuilder to make clients and the Server to make servers.

Implementations

Create a new DataFrameCodec struct using the crate’s implementation of dataframes for reading and writing dataframes.

Use this method if you don’t want to provide a custom implementation for your dataframes.

Create a new DataFrameCodec struct using any implementation of ws::Dataframe you want. This is useful if you want to manipulate the websocket layer very specifically.

If you only want to be able to send and receive the crate’s DataFrame struct use .default(Context) instead.

There is a default dataframe size limit imposed. Use new_with_limits to override it

Trait Implementations

The type of decoded frames.

The type of unrecoverable frame decoding errors. Read more

Attempts to decode a frame from the provided buffer of bytes. Read more

A default method available to be called when there are no more bytes available to be read from the underlying I/O. Read more

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data. Read more

The type of items consumed by the Encoder

The type of encoding errors. Read more

Encodes a frame into the buffer provided. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Get the TypeId of this object.