Struct bytecodec::fixnum::U24leDecoder

pub struct U24leDecoder(_);

Decoder which decodes unsigned 24-bit integers by little-endian byte order.

The type of decoded values is u32, but the most significant 8-bits always be 0.

Examples

use bytecodec::Decode;
use bytecodec::fixnum::U24leDecoder;
use bytecodec::io::IoDecodeExt;

let mut decoder = U24leDecoder::new();
let item = decoder.decode_exact([0x01, 0x02, 0x03].as_ref()).unwrap();
assert_eq!(item, 0x0003_0201u32);

Methods

impl U24leDecoder

pub fn new() -> Self

Makes a new U24leDecoder instance.

Trait Implementations

impl Debug for U24leDecoder

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

Formats the value using the given formatter.

impl Default for U24leDecoder

fn default() -> U24leDecoder

Returns the "default value" for a type.

impl Decode for U24leDecoder

type Item = u32

The type of items to be decoded.

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

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

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

Finishes the current decoding process and returns the decoded item.

fn requiring_bytes(&self) -> ByteCount

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

fn is_idle(&self) -> bool

Returns true if there are no items to be decoded by the decoder at the next invocation of decode method, otherwise false.