X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Flib.rs;h=ba6d6bc71910e53ad37236dc30b6e19cd947a4d9;hb=22dc96481be1ab2eb4ff5bf9074ced29095f4be8;hp=6d4cc50a920cad4cde49b91d0329e227c6ad6379;hpb=62b1e01ad99a46d5824912272962644d9d7ae002;p=rust-lightning

diff --git a/lightning/src/lib.rs b/lightning/src/lib.rs
index 6d4cc50a..ba6d6bc7 100644
--- a/lightning/src/lib.rs
+++ b/lightning/src/lib.rs
@@ -17,6 +17,25 @@
 //! figure out how best to make networking happen/timers fire/things get written to disk/keys get
 //! generated/etc. This makes it a good candidate for tight integration into an existing wallet
 //! instead of having a rather-separate lightning appendage to a wallet.
+//! 
+//! `default` features are:
+//!
+//! * `std` - enables functionalities which require `std`, including `std::io` trait implementations and things which utilize time
+//! * `grind_signatures` - enables generation of [low-r bitcoin signatures](https://bitcoin.stackexchange.com/questions/111660/what-is-signature-grinding),
+//! which saves 1 byte per signature in 50% of the cases (see [bitcoin PR #13666](https://github.com/bitcoin/bitcoin/pull/13666))
+//!
+//! Available features are:
+//!
+//! * `std`
+//! * `grind_signatures`
+//! * `no-std ` - exposes write trait implementations from the `core2` crate (at least one of `no-std` or `std` are required)
+//! * Skip logging of messages at levels below the given log level:
+//!     * `max_level_off`
+//!     * `max_level_error`
+//!     * `max_level_warn`
+//!     * `max_level_info`
+//!     * `max_level_debug`
+//!     * `max_level_trace`
 
 #![cfg_attr(not(any(test, fuzzing, feature = "_test_utils")), deny(missing_docs))]
 #![cfg_attr(not(any(test, fuzzing, feature = "_test_utils")), forbid(unsafe_code))]
@@ -59,9 +78,11 @@ pub mod ln;
 pub mod routing;
 
 #[cfg(feature = "std")]
-use std::io;
+/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
+pub use std::io;
 #[cfg(not(feature = "std"))]
-use core2::io;
+/// Re-export of either `core2::io` or `std::io`, depending on the `std` feature flag.
+pub use core2::io;
 
 #[cfg(not(feature = "std"))]
 mod io_extras {
@@ -158,7 +179,9 @@ mod sync {
 	#[cfg(test)]
 	pub use debug_sync::*;
 	#[cfg(not(test))]
-	pub use ::std::sync::{Arc, Mutex, Condvar, MutexGuard, RwLock, RwLockReadGuard};
+	pub use ::std::sync::{Arc, Mutex, Condvar, MutexGuard, RwLock, RwLockReadGuard, RwLockWriteGuard};
+	#[cfg(not(test))]
+	pub use crate::util::fairrwlock::FairRwLock;
 }
 
 #[cfg(not(feature = "std"))]