Struct irc_proto::line::LineCodec

pub struct LineCodec { /* fields omitted */ }

A line-based codec parameterized by an encoding.

Implementations

impl LineCodec

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

Creates a new instance of LineCodec from the specified encoding.

Trait Implementations

impl Decoder for LineCodec

type Item = String

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<String>>

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<String> for LineCodec

type Error = ProtocolError

The type of encoding errors.

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

Encodes a frame into the buffer provided.