Create a simple `FairRwLock` to avoid readers starving writers
[rust-lightning] / lightning / src / util / mod.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 //! Some utility modules live here. See individual sub-modules for more info.
11
12 #[macro_use]
13 pub(crate) mod fuzz_wrappers;
14
15 #[macro_use]
16 pub(crate) mod ser_macros;
17
18 pub mod events;
19 pub mod errors;
20 pub mod ser;
21 pub mod message_signing;
22 pub mod invoice;
23 pub mod persist;
24
25 pub(crate) mod atomic_counter;
26 pub(crate) mod byte_utils;
27 pub(crate) mod chacha20;
28 #[cfg(feature = "std")]
29 pub(crate) mod fairrwlock;
30 #[cfg(fuzzing)]
31 pub mod zbase32;
32 #[cfg(not(fuzzing))]
33 pub(crate) mod zbase32;
34 #[cfg(not(fuzzing))]
35 pub(crate) mod poly1305;
36 pub(crate) mod chacha20poly1305rfc;
37 pub(crate) mod transaction_utils;
38 pub(crate) mod scid_utils;
39
40 /// Logging macro utilities.
41 #[macro_use]
42 pub(crate) mod macro_logger;
43
44 /// Cryptography utilities.
45 pub(crate) mod crypto;
46
47 // These have to come after macro_logger to build
48 pub mod logger;
49 pub mod config;
50
51 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
52 pub mod test_utils;
53
54 /// impls of traits that add exra enforcement on the way they're called. Useful for detecting state
55 /// machine errors and used in fuzz targets and tests.
56 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
57 pub mod enforcing_trait_impls;
58