futuresdr 0.0.40

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
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

//! Developer-facing runtime APIs for implementing custom blocks, buffers, and
//! runtime extensions.
//!
//! App authors building and running flowgraphs should generally prefer
//! [`crate::prelude`] and the top-level [`crate::runtime`] APIs.

pub use super::block::Block;
pub use super::block_inbox::BlockInbox;
pub use super::block_inbox::BlockNotifier;
pub use super::block_meta::BlockMeta;
pub use super::buffer::BufferReader;
pub use super::buffer::BufferWriter;
pub use super::buffer::CircuitWriter;
pub use super::buffer::CpuBufferReader;
pub use super::buffer::CpuBufferWriter;
pub use super::buffer::CpuSample;
pub use super::buffer::DefaultCpuReader;
pub use super::buffer::DefaultCpuWriter;
pub use super::buffer::InplaceBuffer;
pub use super::buffer::InplaceReader;
pub use super::buffer::InplaceWriter;
pub use super::flowgraph::TypedBlockGuard;
pub use super::flowgraph::TypedBlockGuardMut;
pub use super::kernel::Kernel;
pub use super::message_output::MessageOutputs;
pub use super::tag::ItemTag;
pub use super::tag::Tag;
pub use super::work_io::WorkIo;

/// Marker trait for values that must be `Send` on native runtimes but not on wasm.
///
/// FutureSDR uses this bound on futures and block internals that may be moved
/// between native executor threads. On `wasm32`, where the runtime is
/// single-threaded, the marker does not require `Send`.
#[cfg(not(target_arch = "wasm32"))]
pub trait MaybeSend: Send {}
#[cfg(not(target_arch = "wasm32"))]
impl<T: Send + ?Sized> MaybeSend for T {}

/// Marker trait for values that must be `Send` on native runtimes but not on wasm.
///
/// FutureSDR uses this bound on futures and block internals that may be moved
/// between native executor threads. On `wasm32`, where the runtime is
/// single-threaded, the marker does not require `Send`.
#[cfg(target_arch = "wasm32")]
pub trait MaybeSend {}
#[cfg(target_arch = "wasm32")]
impl<T: ?Sized> MaybeSend for T {}

/// Prelude for implementing custom blocks and runtime extensions.
///
/// This prelude includes the application-facing [`crate::prelude`] plus the
/// traits, buffer types, message helpers, tags, and macros needed by custom
/// block implementations.
pub mod prelude {
    pub use crate::prelude::*;
    #[cfg(feature = "burn")]
    pub use crate::runtime::buffer::burn as burn_buffer;
    pub use crate::runtime::buffer::circuit;
    #[cfg(not(target_arch = "wasm32"))]
    pub use crate::runtime::buffer::circular;
    pub use crate::runtime::buffer::slab;
    pub use crate::runtime::channel::mpsc;
    pub use crate::runtime::channel::oneshot;
    pub use crate::runtime::dev::Block;
    pub use crate::runtime::dev::BlockInbox;
    pub use crate::runtime::dev::BlockMeta;
    pub use crate::runtime::dev::BlockNotifier;
    pub use crate::runtime::dev::BufferReader;
    pub use crate::runtime::dev::BufferWriter;
    pub use crate::runtime::dev::CircuitWriter;
    pub use crate::runtime::dev::CpuBufferReader;
    pub use crate::runtime::dev::CpuBufferWriter;
    pub use crate::runtime::dev::CpuSample;
    pub use crate::runtime::dev::DefaultCpuReader;
    pub use crate::runtime::dev::DefaultCpuWriter;
    pub use crate::runtime::dev::InplaceBuffer;
    pub use crate::runtime::dev::InplaceReader;
    pub use crate::runtime::dev::InplaceWriter;
    pub use crate::runtime::dev::ItemTag;
    pub use crate::runtime::dev::Kernel;
    pub use crate::runtime::dev::MaybeSend;
    pub use crate::runtime::dev::MessageOutputs;
    pub use crate::runtime::dev::Tag;
    pub use crate::runtime::dev::TypedBlockGuard;
    pub use crate::runtime::dev::TypedBlockGuardMut;
    pub use crate::runtime::dev::WorkIo;
    pub use crate::runtime::macros::Block;
    pub use crate::runtime::macros::async_trait;
}