Add doc comment to StreamGuard

ProjectLighthouseCAU · May 30, 2024 · dfbc117 · dfbc117
1 parent 0484d93
commit dfbc117
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/lighthouse-client/src/utils/stream_guard.rs b/lighthouse-client/src/utils/stream_guard.rs
@@ -3,6 +3,7 @@ use std::{pin::Pin, task::{Context, Poll}};
 use futures::Stream;
 use pin_project::{pin_project, pinned_drop};
 
+/// A stream wrapper that automatically runs a closure when dropped.
 #[pin_project(PinnedDrop)]
 pub struct StreamGuard<S, F> where S: Stream + Unpin, F: FnOnce() {
     #[pin]