Struct LengthPrefixed 

pub struct LengthPrefixed { /* private fields */ }

Length-prefixed framer.

Example

use wire_codec::WriteBuf;
use wire_codec::framing::{Endian, Framer, LengthPrefixed, LengthWidth};

let framer = LengthPrefixed::new(LengthWidth::U16, Endian::Big);

let mut out = [0u8; 16];
let mut buf = WriteBuf::new(&mut out);
framer.write_frame(b"hello", &mut buf).unwrap();
let written = buf.position();
assert_eq!(&out[..written], &[0x00, 0x05, b'h', b'e', b'l', b'l', b'o']);

let frame = framer.next_frame(&out[..written]).unwrap().unwrap();
assert_eq!(frame.payload(), b"hello");
assert_eq!(frame.consumed(), 7);

Implementations

impl LengthPrefixed

pub const fn new(width: LengthWidth, endian: Endian) -> Self

Build a framer using the given prefix width and endianness.

The maximum payload size defaults to the largest value the prefix can encode. Use LengthPrefixed::with_max_payload to tighten it.

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

Override the payload size limit enforced when reading and writing frames.

The limit is clamped to LengthWidth::max_payload of the configured width.

pub const fn width(&self) -> LengthWidth

Configured prefix width.

pub const fn endian(&self) -> Endian

Configured endianness.

pub const fn max_payload(&self) -> u64

Configured maximum payload size in bytes.

Trait Implementations

impl Clone for LengthPrefixed

fn clone(&self) -> LengthPrefixed

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LengthPrefixed

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

Formats the value using the given formatter.

impl Framer for LengthPrefixed

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 Hash for LengthPrefixed

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LengthPrefixed

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

impl Eq for LengthPrefixed

impl StructuralPartialEq for LengthPrefixed