Struct SizeEncoder 

pub struct SizeEncoder { /* private fields */ }

An encoder that counts the size of the encoded data.

This encoder is useful for calculating the size of the encoded data without actually encoding it, allowing you to pre-allocate a buffer of the correct size before encoding the data.

Note that this encoder runs all the same encoding logic as any other encoder, so it will trigger the same side effects that other encoders would trigger (e.g Allocations). See the Encodable trait for more information on idempotent encodes.

Example

use encode::Encodable;
use encode::encoders::SizeEncoder;

let encodable = c"hello, world!";
let mut encoder = SizeEncoder::new();
encodable.encode(&mut encoder).unwrap();
assert_eq!(encoder.size(), 14, "13 bytes from the ASCII string and 1 byte for the null terminator");

Implementations

impl SizeEncoder

pub fn new() -> Self

Creates a new SizeEncoder.

pub fn size(&self) -> usize

Returns the size of the encoded data.

Trait Implementations

impl BaseEncoder for SizeEncoder

type Error = Infallible

The error type returned by all encoding operations.

impl ByteEncoder for SizeEncoder

fn put_slice(&mut self, slice: &[u8]) -> Result<(), Self::Error>

Writes a slice of bytes into the encoder.

fn put_byte(&mut self, _byte: u8) -> Result<(), Self::Error>

Writes a single byte into the encoder.

impl Clone for SizeEncoder

fn clone(&self) -> SizeEncoder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SizeEncoder

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

Formats the value using the given formatter.

impl Default for SizeEncoder

fn default() -> SizeEncoder

Returns the “default value” for a type.

impl From<SizeEncoder> for usize

fn from(encoder: SizeEncoder) -> usize

Converts to this type from the input type.

impl Ord for SizeEncoder

fn cmp(&self, other: &SizeEncoder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SizeEncoder

fn eq(&self, other: &SizeEncoder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SizeEncoder

fn partial_cmp(&self, other: &SizeEncoder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Write for SizeEncoder

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl Copy for SizeEncoder

impl Eq for SizeEncoder

impl StructuralPartialEq for SizeEncoder