Struct mumble_protocol::control::ControlCodec

pub struct ControlCodec<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> { /* fields omitted */ }

A Codec implementation that parses a stream of data into ControlPackets.

Since VoicePackets can be tunneled over the control channel and their encoding and decoding depends on their destination, the control codec also needs to know the side it's on. See ServerControlCodec and ClientControlCodec for the two most reasonable configurations.

Implementations

impl<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> ControlCodec<EncodeDst, DecodeDst>

pub fn new() -> Self

Creates a new control codec.

Trait Implementations

impl<EncodeDst: Debug + VoicePacketDst, DecodeDst: Debug + VoicePacketDst> Debug for ControlCodec<EncodeDst, DecodeDst>

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

Formats the value using the given formatter.

impl<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> Decoder for ControlCodec<EncodeDst, DecodeDst>

type Item = ControlPacket<DecodeDst>

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode(
    &mut self,
    buf: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>

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

fn decode_eof(
    &mut self,
    buf: &mut BytesMut
) -> Result<Option<Self::Item>, Self::Error>

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

fn framed<T>(self, io: T) -> Framed<T, Self> where
    T: AsyncRead + AsyncWrite, 

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.

impl<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> Default for ControlCodec<EncodeDst, DecodeDst>

fn default() -> Self

Returns the "default value" for a type.

impl<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> Encoder<ControlPacket<EncodeDst>> for ControlCodec<EncodeDst, DecodeDst>

type Error = Error

The type of encoding errors.

fn encode(
    &mut self,
    item: ControlPacket<EncodeDst>,
    dst: &mut BytesMut
) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.