futuresdr-types 0.0.14

Polymorphic Types for an Experimental Async SDR Runtime for Heterogeneous Architectures.
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

use serde::Deserialize;
use serde::Serialize;

use crate::BlockId;
use crate::PortId;

/// Description of a `Flowgraph`.
///
/// This struct can be serialized to be used with the REST API.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FlowgraphDescription {
    /// Blocks
    pub blocks: Vec<BlockDescription>,
    /// Stream edges
    pub stream_edges: Vec<(BlockId, PortId, BlockId, PortId)>,
    /// Message edges
    pub message_edges: Vec<(BlockId, PortId, BlockId, PortId)>,
}

/// Description of a `Block`.
///
/// This struct can be serialized to be used with the REST API.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BlockDescription {
    /// Id
    pub id: BlockId,
    /// Type name
    pub type_name: String,
    /// Instance name
    pub instance_name: String,
    /// Stream inputs
    pub stream_inputs: Vec<String>,
    /// Stream outputs
    pub stream_outputs: Vec<String>,
    /// Message inputs
    pub message_inputs: Vec<String>,
    /// Message outputs
    pub message_outputs: Vec<String>,
    /// Blocking
    ///
    /// Blocking blocks have an async API but are spawned in a separate thread, i.e., it is ok to
    /// block inside the async function.
    pub blocking: bool,
}