Struct bytecodec::bytes::Utf8Encoder

pub struct Utf8Encoder<S = String>(_);

Utf8Encoder writes the given Rust string into an output byte sequence.

Examples

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

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

Methods

impl<S> Utf8Encoder<S>

pub fn new() -> Self

Makes a new Utf8Encoder instance.

Trait Implementations

impl<S: Debug> Debug for Utf8Encoder<S>

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

Formats the value using the given formatter.

impl<S> Default for Utf8Encoder<S>

fn default() -> Self

Returns the "default value" for a type.

impl<S: AsRef<str>> Encode for Utf8Encoder<S>

type Item = S

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<S: AsRef<str>> SizedEncode for Utf8Encoder<S>

fn exact_requiring_bytes(&self) -> u64

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