Skip to content

chore: Update docs for BTreeSet #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dragoljub-djuric merged 2 commits into from
May 2, 2025
Merged

chore: Update docs for BTreeSet #297

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ffe6a0
.
dragoljub-djuric May 2, 2025
0efd64f
.
dragoljub-djuric May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 84 additions & 32 deletions src/btreeset.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
///
/// set.insert(42);
/// assert!(set.contains(&42));
Expand All @@ -79,8 +81,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(1);
/// set.insert(2);
/// set.insert(3);
Expand All @@ -95,6 +99,7 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl, Storable};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
/// use std::borrow::Cow;
///
/// #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone)]
Expand All @@ -119,7 +124,8 @@ where
/// };
/// }
///
/// let mut set: BTreeSet<CustomType, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<CustomType, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(CustomType { id: 42 });
/// assert!(set.contains(&CustomType { id: 42 }));
/// ```
Expand Down Expand Up @@ -172,8 +178,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let set: BTreeSet<u64, _> = BTreeSet::init(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let set: BTreeSet<u64, _> = BTreeSet::init(mem_mgr.get(MemoryId::new(0)));
/// ```
pub fn init(memory: M) -> Self {
BTreeSet {
Expand All @@ -187,8 +195,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// ```
pub fn new(memory: M) -> Self {
BTreeSet {
Expand All @@ -202,8 +212,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(42);
///
/// // Save the set to memory
Expand All @@ -229,8 +241,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// assert!(set.insert(42));
/// assert!(!set.insert(42)); // Key already exists
/// ```
Expand All @@ -247,8 +261,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(42);
/// assert!(set.contains(&42));
/// assert!(!set.contains(&7));
Expand All @@ -266,8 +282,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// assert!(set.is_empty());
/// ```
pub fn is_empty(&self) -> bool {
Expand All @@ -283,8 +301,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(42);
/// set.insert(7);
/// assert_eq!(set.len(), 2);
Expand All @@ -299,8 +319,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// let memory = set.into_memory();
/// ```
pub fn into_memory(self) -> M {
Expand All @@ -318,8 +340,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(42);
/// set.clear();
/// assert!(set.is_empty());
Expand All @@ -338,8 +362,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(42);
/// set.insert(7);
/// assert_eq!(set.first(), Some(7));
Expand All @@ -358,8 +384,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(42);
/// set.insert(7);
/// assert_eq!(set.last(), Some(42));
Expand All @@ -377,8 +405,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(42);
/// assert!(set.remove(&42));
/// assert!(!set.contains(&42));
Expand All @@ -396,8 +426,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(42);
/// set.insert(7);
/// assert_eq!(set.pop_last(), Some(42));
Expand All @@ -415,8 +447,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(42);
/// set.insert(7);
/// assert_eq!(set.pop_first(), Some(7));
Expand All @@ -434,8 +468,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(42);
/// set.insert(7);
/// for key in set.iter() {
Expand All @@ -456,8 +492,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(1);
/// set.insert(2);
/// set.insert(3);
Expand All @@ -478,8 +516,10 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// set.insert(1);
/// set.insert(2);
/// set.insert(3);
Expand All @@ -504,9 +544,11 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(1)));
///
/// set1.insert(1);
/// set1.insert(2);
Expand Down Expand Up @@ -573,9 +615,11 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(1)));
///
/// set1.insert(1);
/// set1.insert(2);
Expand Down Expand Up @@ -631,9 +675,11 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(1)));
///
/// set1.insert(1);
/// set1.insert(2);
Expand Down Expand Up @@ -674,9 +720,11 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(1)));
///
/// set1.insert(1);
/// set1.insert(2);
Expand Down Expand Up @@ -737,9 +785,11 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(1)));
///
/// set1.insert(1);
/// set1.insert(2);
Expand Down Expand Up @@ -768,9 +818,11 @@ where
///
/// ```rust
/// use ic_stable_structures::{BTreeSet, DefaultMemoryImpl};
/// use ic_stable_structures::memory_manager::{MemoryId, MemoryManager};
///
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(DefaultMemoryImpl::default());
/// let mem_mgr = MemoryManager::init(DefaultMemoryImpl::default());
/// let mut set1: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(0)));
/// let mut set2: BTreeSet<u64, _> = BTreeSet::new(mem_mgr.get(MemoryId::new(1)));
///
/// set1.insert(1);
/// set1.insert(2);
Expand Down
Loading