Struct irc_proto::irc::IrcCodec

pub struct IrcCodec { /* fields omitted */ }

An IRC codec built around an inner codec.

Implementations

impl IrcCodec

pub fn new(label: &str) -> Result<IrcCodec>

Creates a new instance of IrcCodec wrapping a LineCodec with the specific encoding.

pub fn sanitize(mut data: String) -> String

Sanitizes the input string by cutting up to (and including) the first occurence of a line terminiating phrase (\r\n, \r, or \n). This is used in sending messages through the codec to prevent the injection of additional commands.

Trait Implementations

impl Decoder for IrcCodec

type Item = Message

The type of decoded frames.

type Error = ProtocolError

The type of unrecoverable frame decoding errors.

pub fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Message>>

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 Encoder<Message> for IrcCodec

type Error = ProtocolError

The type of encoding errors.

pub fn encode(&mut self, msg: Message, dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.