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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use crate::{
    frame::{
        micro::parse::{maybe, vec_of},
        parse::{self, maybe_cstring},
        FrameGenerator, FrameParser,
    },
    types::Address,
    MicroframeError, RatmanError, Result,
};
use nom::IResult;
use std::ffi::CString;

/// Create a new address with an optional description identifier
pub struct AddrCreate {
    pub name: Option<CString>,
}

impl FrameGenerator for AddrCreate {
    fn generate(self, buf: &mut Vec<u8>) -> Result<()> {
        match self.name {
            Some(n) => buf.extend_from_slice(n.as_bytes()),
            None => buf.push(0),
        };
        Ok(())
    }
}

impl FrameParser for AddrCreate {
    type Output = Self;
    fn parse(input: &[u8]) -> IResult<&[u8], Self::Output> {
        let (input, maybe_name) = maybe_cstring(input).unwrap();

        let name: Option<CString> = match maybe_name {
            Ok(Some(name)) => Some(name),
            _ => None,
        };

        Ok((input, Self { name }))
    }
}

/// Destroy an existing address, optionally deleting all associated data
pub struct AddrDestroy {
    pub addr: Address,
    pub force: bool,
}

impl FrameGenerator for AddrDestroy {
    fn generate(self, buf: &mut Vec<u8>) -> Result<()> {
        self.addr.generate(buf)?;
        match self.force {
            true => buf.push(1),
            false => buf.push(0),
        }
        Ok(())
    }
}

impl FrameParser for AddrDestroy {
    type Output = Result<Self>;
    fn parse(input: &[u8]) -> IResult<&[u8], Self::Output> {
        let (input, addr) = maybe(parse::take_address, input)?;
        let (input, _) = maybe(parse::take(1 as u8), input)?;

        let res = match addr {
            Some(addr) => Ok(Self { addr, force: false }),
            None => Err(MicroframeError::MissingFields(&["addr"])),
        }
        .map_err(|e| RatmanError::Microframe(e));

        Ok((input, res))
    }
}

/// Mark an address as up
pub struct AddrUp {
    pub addr: Address,
}

impl FrameGenerator for AddrUp {
    fn generate(self, buf: &mut Vec<u8>) -> Result<()> {
        self.addr.generate(buf)?;
        Ok(())
    }
}

impl FrameParser for AddrUp {
    type Output = Result<Self>;
    fn parse(input: &[u8]) -> IResult<&[u8], Self::Output> {
        let (input, addr) = maybe(parse::take_address, input)?;

        let res = match addr {
            Some(addr) => Ok(Self { addr }),
            None => Err(MicroframeError::MissingFields(&["addr"])),
        }
        .map_err(|e| RatmanError::Microframe(e));

        Ok((input, res))
    }
}

/// Mark an address as down
pub struct AddrDown {
    pub addr: Address,
}

impl FrameGenerator for AddrDown {
    fn generate(self, buf: &mut Vec<u8>) -> Result<()> {
        self.addr.generate(buf)?;
        Ok(())
    }
}

impl FrameParser for AddrDown {
    type Output = Result<Self>;
    fn parse(input: &[u8]) -> IResult<&[u8], Self::Output> {
        let (input, addr) = maybe(parse::take_address, input)?;

        let res = match addr {
            Some(addr) => Ok(Self { addr }),
            None => Err(MicroframeError::MissingFields(&["addr"])),
        }
        .map_err(|e| RatmanError::Microframe(e));

        Ok((input, res))
    }
}

/// List all locally available addresses
pub struct AddrList {
    pub list: Vec<Address>,
}

impl FrameGenerator for AddrList {
    fn generate(self, buf: &mut Vec<u8>) -> Result<()> {
        self.list.generate(buf)?;
        Ok(())
    }
}

impl FrameParser for AddrList {
    type Output = Result<Self>;
    fn parse(input: &[u8]) -> IResult<&[u8], Self::Output> {
        let (input, list) = vec_of(parse::take_address, input)?;
        Ok((input, Ok(Self { list })))
    }
}