Skip to content
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

Jump to bottom

feat(ipld): undeprecate for_each methods for hamt/kamt #2080

Merged
merged 1 commit into from
Nov 20, 2024
Merged

feat(ipld): undeprecate for_each methods for hamt/kamt #2080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion ipld/amt/benches/amt_benchmark.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,6 @@ fn for_each(c: &mut Criterion) {
c.bench_function("AMT for_each function", |b| {
b.iter(|| {
let a = Amt::load(&cid, &db).unwrap();
#[allow(deprecated)]
black_box(a).for_each(|_, _v: &u64| Ok(())).unwrap();
})
});
Expand Down
4 changes: 0 additions & 4 deletions ipld/amt/src/amt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,6 @@ where
/// assert_eq!(&values, &[(1, "One".to_owned()), (4, "Four".to_owned())]);
/// ```
#[inline]
#[deprecated = "use `.iter()` instead"]
pub fn for_each<F>(&self, mut f: F) -> Result<(), Error>
where
F: FnMut(u64, &V) -> anyhow::Result<()>,
Expand All @@ -462,7 +461,6 @@ where

/// Iterates over each value in the Amt and runs a function on the values, for as long as that
/// function keeps returning `true`.
#[deprecated = "use `.iter()` instead"]
pub fn for_each_while<F>(&self, mut f: F) -> Result<(), Error>
where
F: FnMut(u64, &V) -> anyhow::Result<bool>,
Expand Down Expand Up @@ -508,7 +506,6 @@ where
/// assert_eq!(num_traversed, 3);
/// assert_eq!(next_idx, Some(10));
/// ```
#[deprecated = "use `.iter_from()` and `.take(limit)` instead"]
pub fn for_each_ranged<F>(
&self,
start_at: Option<u64>,
Expand Down Expand Up @@ -539,7 +536,6 @@ where
/// `limit` elements have been traversed. Returns a tuple describing the number of elements
/// iterated over and optionally the index of the next element in the AMT if more elements
/// remain.
#[deprecated = "use `.iter_from()` and `.take(limit)` instead"]
pub fn for_each_while_ranged<F>(
&self,
start_at: Option<u64>,
Expand Down
2 changes: 0 additions & 2 deletions ipld/amt/src/iter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,6 @@ mod tests {
let k = Amt::<&str, _>::new_from_iter(&mem, data.iter().map(|s| &**s)).unwrap();
let a: Amt<String, _> = Amt::load(&k, &mem).unwrap();
let mut restored = Vec::new();
#[allow(deprecated)]
a.for_each(|k, v| {
restored.push((k as usize, v.clone()));
Ok(())
Expand Down Expand Up @@ -381,7 +380,6 @@ mod tests {
let new_amt = Amt::load(&c, &db).unwrap();

let mut x = 0;
#[allow(deprecated)]
new_amt
.for_each(|k, _: &BytesDe| {
if k != indexes[x] {
Expand Down
11 changes: 0 additions & 11 deletions ipld/amt/tests/amt_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,6 @@ fn for_each() {

// Iterate over amt with dirty cache
let mut x = 0;
#[allow(deprecated)]
a.for_each(|_, _: &BytesDe| {
x += 1;
Ok(())
Expand All @@ -367,7 +366,6 @@ fn for_each() {
assert_eq!(new_amt.count(), indexes.len() as u64);

let mut x = 0;
#[allow(deprecated)]
new_amt
.for_each(|i, _: &BytesDe| {
if i != indexes[x] {
Expand All @@ -382,7 +380,6 @@ fn for_each() {
.unwrap();
assert_eq!(x, indexes.len());

#[allow(deprecated)]
new_amt.for_each(|_, _: &BytesDe| Ok(())).unwrap();
assert_eq!(
c.to_string().as_str(),
Expand Down Expand Up @@ -420,7 +417,6 @@ fn for_each_ranged() {
// Iterate over amt with dirty cache from different starting values
for start_val in 0..RANGE {
let mut retrieved_values = Vec::new();
#[allow(deprecated)]
let (count, next_key) = a
.for_each_while_ranged(Some(start_val), None, |index, _: &BytesDe| {
retrieved_values.push(index);
Expand All @@ -436,7 +432,6 @@ fn for_each_ranged() {

// Iterate out of bounds
for i in [RANGE, RANGE + 1, 2 * RANGE, 8 * RANGE] {
#[allow(deprecated)]
let (count, next_key) = a
.for_each_while_ranged(Some(i), None, |_, _: &BytesDe| {
panic!("didn't expect to iterate")
Expand All @@ -449,7 +444,6 @@ fn for_each_ranged() {
// Iterate over amt with dirty cache with different page sizes
for page_size in 1..=RANGE {
let mut retrieved_values = Vec::new();
#[allow(deprecated)]
let (count, next_key) = a
.for_each_while_ranged(None, Some(page_size), |index, _: &BytesDe| {
retrieved_values.push(index);
Expand All @@ -471,7 +465,6 @@ fn for_each_ranged() {
let mut retrieved_values = Vec::new();
let mut start_cursor = None;
loop {
#[allow(deprecated)]
let (num_traversed, next_cursor) = a
.for_each_while_ranged(start_cursor, Some(page_size), |idx, _val| {
retrieved_values.push(idx);
Expand All @@ -497,7 +490,6 @@ fn for_each_ranged() {
let mut retrieved_values = Vec::new();
let mut start_cursor = None;
loop {
#[allow(deprecated)]
let (num_traversed, next_cursor) = a
.for_each_ranged(start_cursor, Some(page_size), |idx, _val: &BytesDe| {
retrieved_values.push(idx);
Expand All @@ -523,7 +515,6 @@ fn for_each_ranged() {

// Iterate over the amt with dirty cache ignoring gaps in the address space including at the
// beginning of the amt, we should only see the values that were not deleted
#[allow(deprecated)]
let (num_traversed, next_cursor) = a
.for_each_while_ranged(Some(0), Some(501), |i, _v| {
assert_eq!((i / 10) % 2, 1); // only "odd" batches of ten 10 - 19, 30 - 39, etc. should be present
Expand All @@ -536,7 +527,6 @@ fn for_each_ranged() {
// flush the amt to the blockstore, reload and repeat the test with a clean cache
let cid = a.flush().unwrap();
let a = Amt::load(&cid, &db).unwrap();
#[allow(deprecated)]
let (num_traversed, next_cursor) = a
.for_each_while_ranged(Some(0), Some(501), |i, _v: &BytesDe| {
assert_eq!((i / 10) % 2, 1); // only "odd" batches of ten 10 - 19, 30 - 39, etc. should be present
Expand Down Expand Up @@ -632,7 +622,6 @@ fn new_from_iter() {

let a: Amt<String, _> = Amt::load(&k, &mem).unwrap();
let mut restored = Vec::new();
#[allow(deprecated)]
a.for_each(|k, v| {
restored.push((k as usize, v.clone()));
Ok(())
Expand Down
1 change: 0 additions & 1 deletion ipld/kamt/src/kamt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,6 @@ where
/// assert_eq!(total, 3);
/// ```
#[inline]
#[deprecated = "use `.iter()` instead"]
pub fn for_each<F>(&self, mut f: F) -> Result<(), Error>
where
V: DeserializeOwned,
Expand Down
Loading