anybox-rs 0.3.0

one API for the most popular passthrough boxes
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

use crate::backend::Input;
use crate::capability::Action;
use crate::event::BoxTime;

pub(crate) type Frame = Vec<u8>;

/// what ties a reply to the request waiting for it. when several requests share a key, the replies
/// complete them in the order they were sent
pub(crate) type Key = u32;

#[derive(Debug)]
pub(crate) enum Incoming {
    Reply(Key),
    Input {
        input: Input,
        box_time: Option<BoxTime>,
    },
    /// several at once, for a box that reports a whole state and leaves it to us to find what changed
    Inputs(Vec<Input>),
    /// the box turned an input stream off on its own
    StreamLost(crate::backend::InputKind),
    /// the box refused the command with this key. if a request is waiting on the key this completes it,
    /// otherwise the core gets told
    Refused {
        key: Key,
        /// none for the library's own queries, because the app never sent those
        action: Option<Action>,
    },
    Noise,
}

/// one family's wire format, so where a frame ends and what it is
pub(crate) trait Codec: Send + 'static {
    /// takes one whole frame off the front of the buffer, or leaves the buffer alone until more bytes come
    fn split(&mut self, buffer: &mut Vec<u8>) -> Option<Frame>;
    fn classify(&mut self, frame: &Frame) -> Incoming;
}