Skip to content

Commit c280ef4

Browse files
committed
Added doc comments.
1 parent d8d55ba commit c280ef4

File tree

1 file changed

+4
-0
lines changed
  • server/swimos_agent/src/lanes/map

1 file changed

+4
-0
lines changed

server/swimos_agent/src/lanes/map/mod.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1164,6 +1164,8 @@ enum DropOrTakeState<C, K, V> {
11641164
Removing(MapLaneRemoveMultiple<C, K, V>),
11651165
}
11661166

1167+
/// An [event handler](crate::event_handler::EventHandler)`] that will either retain or drop the first `n` elements
1168+
/// from a map (ordering the keys by the ordering of their Recon model representations).
11671169
pub struct MapLaneDropOrTake<C, K, V> {
11681170
projection: for<'a> fn(&'a C) -> &'a MapLane<K, V>,
11691171
kind: DropOrTake,
@@ -1313,6 +1315,8 @@ enum SelectDropOrTakeState<C, K, V, F> {
13131315
Done,
13141316
}
13151317

1318+
/// An [event handler](crate::event_handler::EventHandler) that attempts to drop or retain the first `n` elements of
1319+
/// a map lane, if that lane exists.
13161320
pub struct MapLaneSelectDropOrTake<C, K, V, F> {
13171321
kind: DropOrTake,
13181322
number: u64,

0 commit comments

Comments
 (0)