Struct postcard::accumulator::CobsAccumulator
source · pub struct CobsAccumulator<const N: usize> { /* private fields */ }
Expand description
An accumulator used to collect chunked COBS data and deserialize it.
This is often useful when you receive “parts” of the message at a time, for example when draining a serial port buffer that may not contain an entire uninterrupted message.
§Examples
Deserialize a struct by reading chunks from a Read
er.
use postcard::accumulator::{CobsAccumulator, FeedResult};
use serde::Deserialize;
use std::io::Read;
let input = /* Anything that implements the `Read` trait */
let mut raw_buf = [0u8; 32];
let mut cobs_buf: CobsAccumulator<256> = CobsAccumulator::new();
while let Ok(ct) = input.read(&mut raw_buf) {
// Finished reading input
if ct == 0 {
break;
}
let buf = &raw_buf[..ct];
let mut window = &buf[..];
'cobs: while !window.is_empty() {
window = match cobs_buf.feed::<MyData>(&window) {
FeedResult::Consumed => break 'cobs,
FeedResult::OverFull(new_wind) => new_wind,
FeedResult::DeserError(new_wind) => new_wind,
FeedResult::Success { data, remaining } => {
// Do something with `data: MyData` here.
dbg!(data);
remaining
}
};
}
}
Implementations§
source§impl<const N: usize> CobsAccumulator<N>
impl<const N: usize> CobsAccumulator<N>
sourcepub fn feed<'a, T>(&mut self, input: &'a [u8]) -> FeedResult<'a, T>where
T: for<'de> Deserialize<'de>,
pub fn feed<'a, T>(&mut self, input: &'a [u8]) -> FeedResult<'a, T>where
T: for<'de> Deserialize<'de>,
Appends data to the internal buffer and attempts to deserialize the accumulated data into
T
.
sourcepub fn feed_ref<'de, 'a, T>(&'de mut self, input: &'a [u8]) -> FeedResult<'a, T>where
T: Deserialize<'de>,
pub fn feed_ref<'de, 'a, T>(&'de mut self, input: &'a [u8]) -> FeedResult<'a, T>where
T: Deserialize<'de>,
Appends data to the internal buffer and attempts to deserialize the accumulated data into
T
.
This differs from feed, as it allows the T
to reference data within the internal buffer, but
mutably borrows the accumulator for the lifetime of the deserialization.
If T
does not require the reference, the borrow of self
ends at the end of the function.
Trait Implementations§
Auto Trait Implementations§
impl<const N: usize> Freeze for CobsAccumulator<N>
impl<const N: usize> RefUnwindSafe for CobsAccumulator<N>
impl<const N: usize> Send for CobsAccumulator<N>
impl<const N: usize> Sync for CobsAccumulator<N>
impl<const N: usize> Unpin for CobsAccumulator<N>
impl<const N: usize> UnwindSafe for CobsAccumulator<N>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more