Skip to content

Commit

Permalink
Add doc comment on StatusList pointing to SizedStatusList.
Browse files Browse the repository at this point in the history
  • Loading branch information
timothee-haudebourg committed Sep 20, 2024
1 parent e5abf36 commit 4378b7f
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions crates/status/src/impl/bitstring_status_list/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -595,6 +595,11 @@ impl OverflowingSignedShift for u8 {
}
}

/// Status list.
///
/// This type does not store the actual status size (the size of each item)
/// nor the total number of items in the list. Use the [`SizedStatusList`] type
/// to access the list safely with regard to the items boundaries.
#[derive(Debug, Clone)]
pub struct StatusList {
bit_string: BitString,
Expand Down

0 comments on commit 4378b7f

Please sign in to comment.