Struct sip_codec::codec::SIPCodec

pub struct SIPCodec { /* fields omitted */ }

A tokio-codec for sending and receiving SIP messages

SIPCodec will automatically turn raw text into Messages, and vice versa. This can be used to easily interface with tokio streams, as they have built-in support for codecs. See the Tokio docs on framed streams for more.

Currently, it only supports decoding SIP requests.

Trait Implementations

impl Eq for SIPCodec

impl Copy for SIPCodec

impl PartialEq<SIPCodec> for SIPCodec

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Clone for SIPCodec

fn clone(&self) -> SIPCodec

Returns a copy of the value.

default fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for SIPCodec

fn default() -> Self

Returns the "default value" for a type.

impl Debug for SIPCodec

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

Formats the value using the given formatter.

impl Hash for SIPCodec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Encoder for SIPCodec

type Item = Message

The type of items consumed by the Encoder

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.

impl Decoder for SIPCodec

type Item = Message

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

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

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

default fn framed<T>(self, io: T) -> Framed<T, Self> where
    Self: Encoder,
    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.