tightbeam-rs 0.9.0

A secure, high-performance messaging protocol library
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Prelude module for convenient imports
//!
//! This module re-exports commonly used types, traits, and macros from the
//! tightbeam crate, organized into two main categories:
//!
//! - `emit`: For creating and sending TightBeam messages
//! - `collect`: For receiving and processing TightBeam messages
//!
//! # Examples
//!
//! ```
//! use tightbeam::prelude::*;
//! ```

// Multi-threading support
#[cfg(any(feature = "std", feature = "tokio"))]
pub use crate::mpsc;
// ASN.1/DER support
pub use der::{Decode, Encode, Sequence};

// Core types
pub use crate::asn1;
pub use crate::error;
pub use crate::flags;
pub use crate::flags::FlagSet;
pub use crate::matrix::*;
pub use crate::utils;
pub use crate::TightBeamError;
pub use crate::{Frame, Message, Version};

// Derive macro
#[cfg(feature = "derive")]
pub use crate::Beamable;

// Builder support
#[cfg(feature = "builder")]
pub use crate::builder::FrameBuilder;

#[cfg(feature = "policy")]
pub mod policy {
	pub use crate::policy::*;

	#[cfg(feature = "transport-policy")]
	pub use crate::transport::policy::*;
}

#[cfg(feature = "tcp")]
pub use crate::transport::tcp::TightBeamSocketAddr;

// Macros
#[cfg(feature = "derive")]
pub mod tb {
	#[cfg(feature = "builder")]
	pub use crate::flagset;

	#[cfg(feature = "transport")]
	pub use crate::{client, server};
	#[cfg(feature = "compress")]
	pub use crate::{compress, decompress};
	#[cfg(feature = "std")]
	pub use crate::{mutex, rwlock};
	#[cfg(feature = "signature")]
	pub use crate::{notarize, sign};

	pub use crate::asn1::MessagePriority;
	pub use crate::asn1::Version;
}

/// Message emission and creation
pub mod emit {
	#[cfg(feature = "builder")]
	pub use crate::builder::FrameBuilder;
}

/// Message collection and processing
pub mod collect {
	#[cfg(feature = "transport")]
	pub use crate::transport::{MessageCollector, ResponseHandler};

	#[cfg(feature = "transport-policy")]
	pub use crate::transport::policy::{self, PolicyConf};

	#[cfg(feature = "tcp")]
	pub use crate::transport::tcp;

	#[cfg(all(feature = "tcp", feature = "tokio"))]
	pub use crate::transport::tcp::r#async::TokioListener;

	#[cfg(feature = "tcp")]
	pub use crate::transport::tcp::sync::TcpListener;
}

// Crypto module re-exports
#[cfg(feature = "crypto")]
pub mod crypto {
	#[cfg(feature = "aead")]
	pub use crate::crypto::aead;

	#[cfg(feature = "digest")]
	pub use crate::crypto::hash;

	#[cfg(feature = "signature")]
	pub use crate::crypto::sign;

	#[cfg(all(feature = "signature", feature = "secp256k1"))]
	pub use crate::crypto::sign::ecdsa::schnorr;

	#[cfg(feature = "aead")]
	pub use crate::crypto::common;
}