summaryrefslogtreecommitdiff
path: root/src/histbuf.rs
diff options
context:
space:
mode:
authorGravatar Donny Zimmanck <dzimmanck@enphaseenergy.com> 2021-11-12 13:30:58 -0800
committerGravatar Donny Zimmanck <dzimmanck@enphaseenergy.com> 2021-11-12 13:30:58 -0800
commitae103535d3d5a73ae69a3ea78a19248ac3eb2580 (patch)
tree23588c394047e3e20dfc9357dedbb9ff58979ebc /src/histbuf.rs
parent8b320e64e7e7403ec72fed6a19ed17c7791d1090 (diff)
downloadheapless-ae103535d3d5a73ae69a3ea78a19248ac3eb2580.tar.gz
heapless-ae103535d3d5a73ae69a3ea78a19248ac3eb2580.tar.zst
heapless-ae103535d3d5a73ae69a3ea78a19248ac3eb2580.zip
Added doc string to the OrderedIter struct
Diffstat (limited to '')
-rw-r--r--src/histbuf.rs1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/histbuf.rs b/src/histbuf.rs
index ab2c9a3a..3423ef98 100644
--- a/src/histbuf.rs
+++ b/src/histbuf.rs
@@ -272,6 +272,7 @@ impl<T, const N: usize> Default for HistoryBuffer<T, N> {
}
}
+/// An iterator on the underlying buffer ordered from oldest data to newest
#[derive(Clone)]
pub struct OrderedIter<'a, T, const N: usize> {
buf: &'a HistoryBuffer<T, N>,