ratman 0.5.0

Ratman types, client, and interface library
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

//! Ratman client & interface library
//!
//! Ratman is a packet router daemon, which can either run
//! stand-alone, or be embedded into existing applications.  This
//! library provides type definitions, utilities, and interfaces to
//! interact with the Ratman router core.
//!
//! This library can be used in two different ways (not mutually
//! exclusive, although doing both at the same time would be a bit
//! weird.  But we won't judge you).
//!
//! 1. To write a ratman-client application.  Use the types and
//! functions exported from the [client](crate::client) module
//!
//! 2. To write a ratman-netmod driver.  Use the types and functions
//! exported from the [netmod](crate::netmod) module

#[macro_use]
extern crate tracing;

#[cfg(feature = "client")]
pub mod client;

#[cfg(feature = "netmod")]
pub mod netmod;

pub mod types;

// Re-export existing errors at the root to make them more convenient
// to access.  Importantly errors are name-spaced while results are
// not.  A result MUST always be of type Result<T, RatmanError>.
pub use {client::ClientError, netmod::NetmodError, types::RatmanError, types::Result};