futuresdr-remote 0.0.1

Remote interaction library for FutureSDR.
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

#![warn(missing_docs)]
//! # Remote interaction with FutureSDR
//!
//! Library for remote interaction with a FutureSDR runtime and flowgraph.
//!
//! ## Example
//! ```no_run
//! use futuresdr_remote::Error;
//! use futuresdr_remote::Handler;
//! use futuresdr_remote::Remote;
//! use futuresdr_types::Pmt;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Error> {
//!     let remote = Remote::new("http://127.0.0.1:1337");
//!
//!     let fgs = remote.flowgraphs().await?;
//!     let blocks = fgs[0].blocks();
//!
//!     let p = blocks[0].callback(Handler::Id(0), Pmt::U32(123)).await?;
//!     println!("result: {:?}", p);
//!
//!     Ok(())
//! }
//! ```
mod remote;
pub use remote::Block;
pub use remote::Connection;
pub use remote::ConnectionType;
pub use remote::Flowgraph;
pub use remote::Handler;
pub use remote::Remote;

use thiserror::Error;

/// FutureSDR Remote Error
#[derive(Debug, Error)]
pub enum Error {
    /// Error in [`hyper`] crate.
    #[error("Hyper")]
    Hyper(#[from] hyper::Error),
    /// Error parsing a string to a [`hyper::Uri].
    #[error("Invalid uri")]
    Uri(#[from] http::uri::InvalidUri),
    /// IO error.
    #[error("IO error")]
    Io(#[from] std::io::Error),
    /// Error (de-)serializing to JSON.
    #[error("Serde error")]
    Serde(#[from] serde_json::Error),
    /// Wrong HTTP REST URL.
    #[error("Wrong endpoint")]
    Endpoint(hyper::Uri),
    /// Error in [`http`] crate.
    #[error("HTTP error")]
    Http(#[from] http::Error),
    /// Wrong [`Flowgraph`] ID.
    #[error("Wrong flowgraph id")]
    FlowgraphId(usize),
}