Add annotations for things which we cannot (yet) expose

[rust-lightning] / lightning / src / chain / chaininterface.rs

diff --git a/lightning/src/chain/chaininterface.rs b/lightning/src/chain/chaininterface.rs
index 2da2ae8c7eb618a49308e664e4a8edd50266bd58..295c337e29d905ff8e6e5b28ffb4043b76429148 100644 (file)
--- a/lightning/src/chain/chaininterface.rs
+++ b/lightning/src/chain/chaininterface.rs
@@ -226,6 +226,8 @@ impl ChainWatchedUtil {
 /// parameters with static lifetimes). Other times you can afford a reference, which is more
 /// efficient, in which case BlockNotifierRef is a more appropriate type. Defining these type
 /// aliases prevents issues such as overly long function definitions.
+///
+/// (C-not exported) as we let clients handle any reference counting they need to do
 pub type BlockNotifierArc<C> = Arc<BlockNotifier<'static, Arc<ChainListener>, C>>;
 
 /// BlockNotifierRef is useful when you want a BlockNotifier that points to ChainListeners
@@ -273,6 +275,8 @@ impl<'a, CL: Deref + 'a, C: Deref> BlockNotifier<'a, CL, C>
        /// If the same listener is registered multiple times, unregistering
        /// will remove ALL occurrences of that listener. Comparison is done using
        /// the pointer returned by the Deref trait implementation.
+       ///
+       /// (C-not exported) because the equality check would always fail
        pub fn unregister_listener(&self, listener: CL) {
                let mut vec = self.listeners.lock().unwrap();
                // item is a ref to an abstract thing that dereferences to a ChainListener,