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

//
// Copyright (c) 2021 - 2024 ZettaScale Technology
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
//
// Contributors:
//   ZettaScale Zenoh Team, <zenoh@zettascale.tech>
//

//! This crate exposes the traits and structures necessary to create Zenoh-Flow nodes.
//!
//! Items not exposed in the `prelude` are meant for internal usage within the Zenoh-Flow project.
//!
//! # [prelude]
//!
//! Application developers wishing to create a data flow should include the [prelude] in their code-base as it regroups
//! all the required structures and traits:
//!
//! ```
//! use zenoh_flow_nodes::prelude::*;
//! ```
//!
//! Next would be to implement, as different shared libraries, at least a [Source](crate::prelude::Source), a
//! [Sink](crate::prelude::Sink) and possibly some [Operators](crate::prelude::Operator). See their respective
//! documentation for examples.

pub(crate) mod declaration;
pub use declaration::{NodeDeclaration, OperatorFn, SinkFn, SourceFn, CORE_VERSION, RUSTC_VERSION};

pub(crate) mod context;

pub(crate) mod io;
pub use io::{InputBuilder, OutputBuilder};

pub(crate) mod messages;
pub(crate) mod traits;

/// This module expose all the structures required to implement a Zenoh-Flow node.
///
/// It also re-exposes items from the [anyhow], [zenoh_flow_commons] and [zenoh_flow_derive] crates.
pub mod prelude {
    pub use crate::context::Context;
    pub use crate::io::{Input, InputRaw, Inputs, Output, OutputRaw, Outputs};
    pub use crate::messages::{Data, LinkMessage, Payload};
    pub use crate::traits::{Node, Operator, SendSyncAny, Sink, Source};
    pub use anyhow::{anyhow, bail};
    pub use zenoh_flow_commons::{Configuration, Result};
    pub use zenoh_flow_derive::{export_operator, export_sink, export_source};
}