tinyklv 0.1.1

The simplest Key-Length-Value (KLV) framework in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

// --------------------------------------------------
// local
// --------------------------------------------------
use crate::traits::Partial;

#[derive(Debug)]
/// Result of a single [`DecodePartial::decode_partial`] attempt
///
/// Two states only:
///
/// * [`Packet::Ready`] - the partial finalised cleanly into `T`. Input
///   cursor is advanced past the consumed bytes.
/// * [`Packet::NeedMore`] - the decode loop paused because more input
///   is needed. The partial holds every KLV field that landed so far.
///   Feed more bytes into a [`crate::Decoder`] (via
///   [`crate::Decoder::feed`] + [`crate::Decoder::next`]), or
///   call [`crate::traits::ResumePartial::resume_partial`] directly,
///   once more bytes are available. Malformed input surfaces as
///   `Err(&'static str)` on the outer `Result` from
///   [`crate::traits::DecodePartial::decode_partial`].
pub enum Packet<T, P>
where
    P: Partial<Final = T>,
{
    /// Decode succeeded; `T` is the value and `input` has advanced past it
    Ready(T),

    /// Decode needs more bytes. The partial holds every klv field
    /// landed so far. Hand it back to [`ResumePartial::resume_partial`]
    /// (or wrap into a [`crate::Decoder`] for buffered streaming) once
    /// more bytes are available
    NeedMore(P),
}