Struct CodecLen

pub struct CodecLen { /* private fields */ }

A dummy writer that counts bytes instead of actually writing them.

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).

Example

use devela::{IoWrite, Encodable, CodecLen};

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

Vendored

This is adapted work from encode.

Implementations

impl CodecLen

pub const fn new() -> Self

Creates a new CodecLen.

pub const fn size(&self) -> usize

Returns the computed encoded size.

Trait Implementations

impl Clone for CodecLen

fn clone(&self) -> CodecLen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodecLen

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

Formats the value using the given formatter.

impl Default for CodecLen

fn default() -> CodecLen

Returns the “default value” for a type.

impl From<CodecLen> for usize

fn from(encoder: CodecLen) -> usize

Converts to this type from the input type.

impl Ord for CodecLen

fn cmp(&self, other: &CodecLen) -> 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 CodecLen

fn eq(&self, other: &CodecLen) -> 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 CodecLen

fn partial_cmp(&self, other: &CodecLen) -> 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 CodecLen

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

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 Write for CodecLen

fn write(&mut self, slice: &[u8]) -> IoResult<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> IoResult<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl Copy for CodecLen

impl Eq for CodecLen

impl StructuralPartialEq for CodecLen