f Add comment to OptionalSelector

lightningdevkit · Jul 30, 2024 · e3ed93b · e3ed93b
1 parent df38fd5
commit e3ed93b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
@@ -547,6 +547,8 @@ pub(crate) mod futures_util {
 		}
 	}
 
+	/// A selector that takes a future wrapped in an option that will be polled if it is `Some` and
+	/// will always be pending otherwise.
 	pub(crate) struct OptionalSelector<F: Future<Output = ()> + Unpin> {
 		pub optional_future: Option<F>,
 	}