selium-abi 1.0.0-alpha.6

Streaming compute fabric
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

use rkyv::{Archive, Deserialize, Serialize};

/// Backpressure behaviour for channel writers.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[rkyv(bytecheck())]
#[repr(u8)]
pub enum ChannelBackpressure {
    /// Writers wait for buffer space when the channel is full.
    Park = 0,
    /// Writers drop payloads when the channel is full.
    Drop = 1,
}

/// Request to create a new channel.
#[derive(Debug, Clone, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[rkyv(bytecheck())]
pub struct ChannelCreate {
    /// Channel capacity in bytes.
    pub capacity: crate::GuestUint,
    /// Backpressure behaviour for writers.
    pub backpressure: ChannelBackpressure,
}

/// Request to read data from a reader.
#[derive(Debug, Clone, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[rkyv(bytecheck())]
pub struct IoRead {
    /// Handle of the reader.
    pub handle: crate::GuestUint,
    /// Maximum number of bytes to read.
    pub len: crate::GuestUint,
}

/// Request to write data to a writer.
#[derive(Debug, Clone, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[rkyv(bytecheck())]
pub struct IoWrite {
    /// Handle of the writer.
    pub handle: crate::GuestUint,
    /// Payload to be written.
    pub payload: Vec<u8>,
}

/// Response carrying an attributed frame.
#[derive(Debug, Clone, PartialEq, Eq, Archive, Serialize, Deserialize)]
#[rkyv(bytecheck())]
pub struct IoFrame {
    /// Identifier of the writer that produced this frame.
    pub writer_id: u16,
    /// Frame payload.
    pub payload: Vec<u8>,
}