Struct bytecodec::DecodedValue

pub struct DecodedValue<T>(_);

DecodedValue represents a decoded item.

It does not consume any bytes, and returns the given item when decode() was first called.

Examples

use bytecodec::{Decode, DecodeBuf, DecodedValue};

let mut decoder = DecodedValue::new(10);

let mut input = DecodeBuf::new(b"foo");
let item = decoder.decode(&mut input).unwrap();
assert_eq!(item, Some(10));
assert_eq!(input.len(), 3);

Methods

impl<T> DecodedValue<T>

pub fn new(value: T) -> Self

Makes a new DecodedValue instance.

Trait Implementations

impl<T: Debug> Debug for DecodedValue<T>

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

Formats the value using the given formatter.

impl<T> Decode for DecodedValue<T>

type Item = T

The type of items to be decoded.

fn decode(&mut self, _buf: &mut DecodeBuf) -> Result<Option<Self::Item>>

Consumes the given buffer (a part of a byte sequence), and decodes an item from it.

fn has_terminated(&self) -> bool

Returns true if the decoder cannot decode items anymore, otherwise false.

fn is_idle(&self) -> bool

Returns true if the decoder does not have an item that being decoded, otherwise false.

fn requiring_bytes_hint(&self) -> Option<u64>

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