Struct Delimited 

pub struct Delimited<'d> { /* private fields */ }

Byte-delimited framer.

Example

use wire_codec::WriteBuf;
use wire_codec::framing::{Delimited, Framer};

let framer = Delimited::new(b"\n");

let mut out = [0u8; 32];
let mut buf = WriteBuf::new(&mut out);
framer.write_frame(b"line one", &mut buf).unwrap();
framer.write_frame(b"line two", &mut buf).unwrap();
let n = buf.position();
assert_eq!(&out[..n], b"line one\nline two\n");

let first = framer.next_frame(&out[..n]).unwrap().unwrap();
assert_eq!(first.payload(), b"line one");
assert_eq!(first.consumed(), 9);

Implementations

impl<'d> Delimited<'d>

pub const fn new(delimiter: &'d [u8]) -> Self

Build a framer using delimiter to separate frames.

Panics

Panics if delimiter is empty. An empty delimiter cannot uniquely separate frames and is a programmer error.

pub const fn with_max_payload(self, max: usize) -> Self

Set an upper bound on payload size. Frames whose payload would exceed this size cause Error::FrameTooLarge.

pub const fn delimiter(&self) -> &'d [u8]

Configured delimiter sequence.

pub const fn max_payload(&self) -> usize

Configured maximum payload size.

Trait Implementations

impl<'d> Clone for Delimited<'d>

fn clone(&self) -> Delimited<'d>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'d> Debug for Delimited<'d>

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

Formats the value using the given formatter.

impl<'d> Framer for Delimited<'d>

fn next_frame<'a>(&self, input: &'a [u8]) -> Result<Option<Frame<'a>>>

Try to extract a single frame from the start of input.

fn write_frame(&self, payload: &[u8], out: &mut WriteBuf<'_>) -> Result<()>

Serialize payload as a single frame into out.

impl<'d> Copy for Delimited<'d>