Struct bytecodec::fixnum::U24beEncoder

pub struct U24beEncoder(_);

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

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

Examples

use bytecodec::EncodeExt;
use bytecodec::fixnum::U24beEncoder;
use bytecodec::io::IoEncodeExt;

let mut output = Vec::new();
let mut encoder = U24beEncoder::with_item(0x0001_0203).unwrap();
encoder.encode_all(&mut output).unwrap();
assert_eq!(output, [0x01, 0x02, 0x03]);

Methods

impl U24beEncoder

pub fn new() -> Self

Makes a new U24beEncoder instance.

Trait Implementations

impl Debug for U24beEncoder

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

Formats the value using the given formatter.

impl Default for U24beEncoder

fn default() -> U24beEncoder

Returns the "default value" for a type.

impl Encode for U24beEncoder

type Item = u32

The type of items to be encoded.

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

Encodes the items in the encoder and writes the encoded bytes to the given buffer.

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

Tries to start encoding the given item.

fn requiring_bytes(&self) -> ByteCount

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 SizedEncode for U24beEncoder

fn exact_requiring_bytes(&self) -> u64

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