Skip to main content

ClientCodec

Enum ClientCodec 

Source
#[non_exhaustive]
pub enum ClientCodec { Uncompressed, Zstd, Brotli, Gzip, }
Expand description

Codec for clients to the Titan WebSocket API version 1.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Uncompressed

V1 messages encoded via MessagePack with no compression.

§

Zstd

V1 messages encoded via MessagePack with zstd compression.

§

Brotli

V1 messages encoded via MessagePack with brotli compression.

§

Gzip

V1 messages encoded via MessagePack with gzip compression.

Trait Implementations§

Source§

impl Codec for ClientCodec

Source§

type SendItem = ClientRequest

The type of message that is sent to the other side.
Source§

type SendError = EncodeError

The type of error that is returned if encoding fails.
Source§

type RecvItem = ServerMessage

The type of message that is expected to be received from the other side.
Source§

type RecvError = DecodeError

The type of error that is returned if decoding fails.
Source§

fn encoder( &self, ) -> Box<dyn TypedEncoder<Self::SendItem, Error = Self::SendError> + Send + Sync>

Generates a new encoder for encoding messages to be sent to the other side of the connection.
Source§

fn decoder( &self, ) -> Box<dyn TypedDecoder<Item = Self::RecvItem, Error = Self::RecvError> + Send + Sync>

Generates a new decoder for encoding messages to be sent to the other side of the connection.
Source§

impl Debug for ClientCodec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ClientCodec

Source§

fn default() -> ClientCodec

Returns the “default value” for a type. Read more
Source§

impl FromStr for ClientCodec

Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Attempts to load a ClientCodec from a WebSocket subprotocol string.

Source§

type Err = CodecLoadError

The associated error which can be returned from parsing.
Source§

impl PartialEq for ClientCodec

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for ClientCodec

Source§

impl StructuralPartialEq for ClientCodec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.