Struct mumble_protocol::voice::VoiceCodec

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

A Codec implementation that parses a stream of data chunks into VoicePackets.

The encoding and decoding of voice packets depends on their destination. See ServerVoiceCodec and ClientVoiceCodec for the two most reasonable configurations.

Implementations

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

pub fn new() -> Self

Creates a new control codec.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Item = VoicePacket<DecodeDst>

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

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

pub 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.

pub 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: Default + VoicePacketDst, DecodeDst: Default + VoicePacketDst> Default for VoiceCodec<EncodeDst, DecodeDst>

pub fn default() -> VoiceCodec<EncodeDst, DecodeDst>

Returns the "default value" for a type.

impl<EncodeDst: VoicePacketDst, DecodeDst: VoicePacketDst> Encoder<VoicePacket<EncodeDst>> for VoiceCodec<EncodeDst, DecodeDst>

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.