libratman 0.7.0

Ratman types, client, and interface library
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! Various Frame abstractions for Irdest tools
//!
//! A frame is a self-contained packet with a unified way of parsing
//! an incoming data stream, usually ending with a payload length,
//! which should be loaded after the given header.

pub mod carrier;
pub mod micro;

pub mod generate;
pub mod parse;

use crate::Result;
use nom::IResult;

pub const EMPTY: &[u8] = &[];

/// A utility trait that represents a parsable frame entity
///
/// This trait is a slim wrapper around the nom parsing
/// infrastructure, aka a top-level parser still needs to map nom
/// errors to RatmanErrors.
pub trait FrameParser {
    type Output;
    fn parse(input: &[u8]) -> IResult<&[u8], Self::Output>;
}

/// A utility trait that represents a serialisable frame entity
///
/// This trait should be implemented for frame sub-types to avoid code
/// duplication when serialising entities.  Additionally this trait
/// consumes the given frame to avoid duplication.
pub trait FrameGenerator {
    fn generate(self, buf: &mut Vec<u8>) -> Result<()>;
}

impl FrameGenerator for () {
    fn generate(self, _: &mut Vec<u8>) -> Result<()> {
        Ok(())
    }
}

impl FrameParser for () {
    type Output = ();
    fn parse(input: &[u8]) -> IResult<&[u8], Self::Output> {
        Ok((input, ()))
    }
}