Trait bytecodec::Decode[−][src]

pub trait Decode {
    type Item;
    fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>;
    fn finish_decoding(&mut self) -> Result<Self::Item>;
    fn requiring_bytes(&self) -> ByteCount;

    fn is_idle(&self) -> bool { ... }
}

This trait allows for decoding items from a byte sequence incrementally.

Associated Types

`type Item`[src]

The type of items to be decoded.

Loading content...

Required methods

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

Consumes the given buffer (a part of a byte sequence), and proceeds the decoding process.

It returns the number of bytes consumed from the input buffer.

If an item is completely decoded, the next invocation of is_idle method will return true. And if is_idle method returns true, decode method should consume no bytes.

The decoder must consume as many bytes in the buffer as possible. If an item is not yet decoded but the number of consumed bytes in the last decode invocation is smaller than the length of buf, it means the decoder has been suspended its work in any reasons. In that case the decoder may require some instructions from clients to resume the work, but its concrete method is beyond the scope of this trait.

Errors

The following errors may be returned by the decoder:

ErrorKind::DecoderTerminated:
- If all decodable items have been decoded, the decoder must return this kind of error when decode method is called.
ErrorKind::UnexpectedEos:
- The invocation of eos.is_reached() returns true despite of the decoder requires more bytes to decode the next item.
ErrorKind::InvalidInput:
- Decoded items have invalid values
- Invalid parameters were given to decoders
ErrorKind::InconsistentState:
- The state of the decoder bocame inconsistent
- This means the implementation contains a bug
ErrorKind::Other:
- Other errors

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

Finishes the current decoding process and returns the decoded item.

Errors

The following errors may be returned by the decoder:

ErrorKind::IncompleteDecoding:
- The decoding process has not been completed
ErrorKind::DecoderTerminated:
- The decoder has terminated (i.e., cannot decode any more items)
ErrorKind::InconsistentState:
- The state of the decoder bocame inconsistent
- This means the implementation contains a bug
ErrorKind::Other:
- Other errors

`fn requiring_bytes(&self) -> ByteCount`[src]

Returns the lower bound of the number of bytes needed to decode the next item.

If the decoder does not know the value, it will return ByteCount::Unknown (e.g., null-terminated strings have no pre-estimable length).

If the decoder returns ByteCount::Finite(0), it means one of the followings:

(a) There is an already decoded item
- The next invocation of decode() will return it without consuming any bytes
(b) There are no decodable items
- All decodable items have been decoded, and the decoder cannot do any further works
- In this case, the next invocation of decode method will fail.

Loading content...

Trait bytecodec::Decode[−][src]

Associated Types

type Item[src]

Required methods

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

Errors

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

Errors

fn requiring_bytes(&self) -> ByteCount[src]

Provided methods

fn is_idle(&self) -> bool[src]

Implementations on Foreign Types

impl<'a, D: ?Sized + Decode> Decode for &'a mut D[src]

type Item = D::Item

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

impl<D: ?Sized + Decode> Decode for Box<D>[src]

type Item = D::Item

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

Implementors

impl Decode for RemainingBytesDecoder[src]

type Item = Vec<u8>

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

impl Decode for F32beDecoder[src]

type Item = f32

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

impl Decode for F32leDecoder[src]

type Item = f32

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

impl Decode for F64beDecoder[src]

type Item = f64

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

impl Decode for F64leDecoder[src]

type Item = f64

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

impl Decode for I8Decoder[src]

type Item = i8

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

impl Decode for I16beDecoder[src]

type Item = i16

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

impl Decode for I16leDecoder[src]

type Item = i16

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

impl Decode for I32beDecoder[src]

type Item = i32

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>[src]

fn finish_decoding(&mut self) -> Result<Self::Item>[src]

fn requiring_bytes(&self) -> ByteCount[src]

fn is_idle(&self) -> bool[src]

impl Decode for I32leDecoder[src]

`type Item`[src]

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl<'a, D: ?Sized + Decode> Decode for &'a mut D`[src]

`type Item = D::Item`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl<D: ?Sized + Decode> Decode for Box<D>`[src]

`type Item = D::Item`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for RemainingBytesDecoder`[src]

`type Item = Vec<u8>`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for F32beDecoder`[src]

`type Item = f32`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for F32leDecoder`[src]

`type Item = f32`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for F64beDecoder`[src]

`type Item = f64`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for F64leDecoder`[src]

`type Item = f64`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for I8Decoder`[src]

`type Item = i8`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for I16beDecoder`[src]

`type Item = i16`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for I16leDecoder`[src]

`type Item = i16`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for I32beDecoder`[src]

`type Item = i32`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for I32leDecoder`[src]

`type Item = i32`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]

`fn finish_decoding(&mut self) -> Result<Self::Item>`[src]

`fn requiring_bytes(&self) -> ByteCount`[src]

`fn is_idle(&self) -> bool`[src]

`impl Decode for I64beDecoder`[src]

`type Item = i64`

`fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>`[src]