Struct bytecodec::bytes::BytesEncoder

pub struct BytesEncoder<B = Vec<u8>> { /* fields omitted */ }

BytesEncoder writes the given bytes into an output byte sequence.

Examples

use bytecodec::{Encode, EncodeExt};
use bytecodec::bytes::BytesEncoder;
use bytecodec::io::IoEncodeExt;

let mut output = Vec::new();
let mut encoder = BytesEncoder::with_item(b"foo").unwrap();
encoder.encode_all(&mut output).unwrap();
assert!(encoder.is_idle());
assert_eq!(output, b"foo");

Methods

impl<B> BytesEncoder<B>

pub fn new() -> Self

Makes a new BytesEncoder instance.

Trait Implementations

impl<B: Debug> Debug for BytesEncoder<B>

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

Formats the value using the given formatter.

impl<B> Default for BytesEncoder<B>

fn default() -> Self

Returns the "default value" for a type.

impl<B: AsRef<[u8]>> Encode for BytesEncoder<B>

type Item = B

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<B: AsRef<[u8]>> SizedEncode for BytesEncoder<B>

fn exact_requiring_bytes(&self) -> u64

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