Struct CodecJoin

pub struct CodecJoin<E, S> { /* private fields */ }

Encodes and decodes an iterator as a sequence with an optional separator.

Example

use devela::{Encodable, CodecJoin};

let compact_map = [ (c"hello", 1u8), (c"world", 2u8) ];
let mut buf = [0u8; 64];
let len = CodecJoin::new(&compact_map).encode(&mut &mut buf[..]).unwrap();
assert_eq!(&buf[..len], b"hello\0\x01world\0\x02");

let mut buf = [0u8; 64];
let array = ["hello", "world", "another"];
let len = CodecJoin::with(&array, ", ").encode(&mut &mut buf[..]).unwrap();
assert_eq!(&buf[..len], b"hello, world, another");

let mut buf = Vec::new();
// Note if you'd use '/' (a char) it would get encoded as [47, 0, 0, 0].
let len = CodecJoin::with(&array, "/").encode(&mut buf).unwrap();
assert_eq!(&buf, b"hello/world/another");

Vendored

This is adapted work from encode.

Implementations

impl<E> CodecJoin<E, ()>

pub const fn new(encodable_iter: E) -> Self

Creates a new CodecJoin combinator, without a separator.

impl<E, S> CodecJoin<E, S>

pub const fn with(encodable_iter: E, separator: S) -> Self

Creates a new CodecJoin combinator with a separator.

Trait Implementations

impl<E: Clone, S: Clone> Clone for CodecJoin<E, S>

fn clone(&self) -> CodecJoin<E, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug, S: Debug> Debug for CodecJoin<E, S>

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

Formats the value using the given formatter.

impl<E, S, W: IoWrite> Encodable<W> for CodecJoin<E, S>

where E: Clone + IntoIterator, E::Item: Encodable<W>, S: Encodable<W>,

fn encode(&self, writer: &mut W) -> IoResult<usize>

Encodes self into the given writer, returning the bytes written.

impl<E: Ord, S: Ord> Ord for CodecJoin<E, S>

fn cmp(&self, other: &CodecJoin<E, S>) -> 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<E: PartialEq, S: PartialEq> PartialEq for CodecJoin<E, S>

fn eq(&self, other: &CodecJoin<E, S>) -> 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<E: PartialOrd, S: PartialOrd> PartialOrd for CodecJoin<E, S>

fn partial_cmp(&self, other: &CodecJoin<E, S>) -> 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<E: Eq, S: Eq> Eq for CodecJoin<E, S>

impl<E, S> StructuralPartialEq for CodecJoin<E, S>