f Add comment to OptionalSelector

tnull · tnull · commit e3ed93b2ddf1 · 2024-07-30T09:39:34.000-05:00
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>,
 	}

Original file line number	Diff line number	Diff line change
`@@ -547,6 +547,8 @@ pub(crate) mod futures_util {`
`547`	`547`	`}`
`548`	`548`	`}`
`549`	`549`
	`550`	+ /// A selector that takes a future wrapped in an option that will be polled if it is `Some` and
	`551`	`+ /// will always be pending otherwise.`
`550`	`552`	`pub(crate) struct OptionalSelector<F: Future<Output = ()> + Unpin> {`
`551`	`553`	`pub optional_future: Option<F>,`
`552`	`554`	`}`