Struct bytecodec::fixnum::U24leEncoder

pub struct U24leEncoder(_);

Encoder which encodes unsigned 24-bit integers by little-endian byte order.

Although the type of items is u32, the most significant 8-bits must be 0.

Examples

use bytecodec::{Encode, EncodeBuf, EncodeExt};
use bytecodec::fixnum::U24leEncoder;

let mut output = [0; 3];
{
    let mut encoder = U24leEncoder::with_item(0x0001_0203).unwrap();
    encoder.encode(&mut EncodeBuf::new(&mut output)).unwrap();
}
assert_eq!(output, [0x03, 0x02, 0x01]);

Methods

impl U24leEncoder

pub fn new() -> Self

Makes a new U24leEncoder instance.

Trait Implementations

impl Debug for U24leEncoder

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

Formats the value using the given formatter.

impl Default for U24leEncoder

fn default() -> U24leEncoder

Returns the "default value" for a type.

impl Encode for U24leEncoder

type Item = u32

The type of items to be encoded.

fn encode(&mut self, buf: &mut EncodeBuf) -> Result<()>

Encodes the current item and writes the encoded bytes to the given buffer as many as possible.

fn start_encoding(&mut self, item: Self::Item) -> Result<()>

Tries to start encoding the given item.

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

Returns the number of bytes required to encode all the items in the encoder.

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false.

impl ExactBytesEncode for U24leEncoder

fn requiring_bytes(&self) -> u64

Returns the number of bytes required to encode all the items in the encoder.