Skip to content

Commit

Permalink
Update test cases/comments in indexed maps
Browse files Browse the repository at this point in the history
  • Loading branch information
maurolacy committed Dec 13, 2021
1 parent 200948f commit 4181f54
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 39 deletions.
42 changes: 21 additions & 21 deletions packages/storage-plus/src/indexed_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ where
}
}

// short-cut for simple keys, rather than .prefix(()).range(...)
// short-cut for simple keys, rather than .prefix(()).range_raw(...)
impl<'a, K, T, I> IndexedMap<'a, K, T, I>
where
K: PrimaryKey<'a>,
Expand Down Expand Up @@ -175,8 +175,8 @@ where
T: Serialize + DeserializeOwned + Clone,
I: IndexList<T>,
{
/// While `range` over a `prefix` fixes the prefix to one element and iterates over the
/// remaining, `prefix_range` accepts bounds for the lowest and highest elements of the `Prefix`
/// While `range_raw` over a `prefix` fixes the prefix to one element and iterates over the
/// remaining, `prefix_range_raw` accepts bounds for the lowest and highest elements of the `Prefix`
/// itself, and iterates over those (inclusively or exclusively, depending on `PrefixBound`).
/// There are some issues that distinguish these two, and blindly casting to `Vec<u8>` doesn't
/// solve them.
Expand Down Expand Up @@ -520,7 +520,7 @@ mod test {
}

#[test]
fn range_simple_key_by_multi_index() {
fn range_raw_simple_key_by_multi_index() {
let mut store = MockStorage::new();
let map = build_map();

Expand Down Expand Up @@ -576,7 +576,7 @@ mod test {
}

#[test]
fn range_de_simple_key_by_multi_index() {
fn range_simple_key_by_multi_index() {
let mut store = MockStorage::new();
let map = build_map();

Expand Down Expand Up @@ -632,7 +632,7 @@ mod test {
}

#[test]
fn range_composite_key_by_multi_index() {
fn range_raw_composite_key_by_multi_index() {
let mut store = MockStorage::new();

let indexes = DataCompositeMultiIndex {
Expand Down Expand Up @@ -693,7 +693,7 @@ mod test {
}

#[test]
fn range_de_composite_key_by_multi_index() {
fn range_composite_key_by_multi_index() {
let mut store = MockStorage::new();

let indexes = DataCompositeMultiIndex {
Expand Down Expand Up @@ -861,7 +861,7 @@ mod test {
}

#[test]
fn range_simple_key_by_unique_index() {
fn range_raw_simple_key_by_unique_index() {
let mut store = MockStorage::new();
let map = build_map();

Expand Down Expand Up @@ -894,7 +894,7 @@ mod test {
}

#[test]
fn range_de_simple_key_by_unique_index() {
fn range_simple_key_by_unique_index() {
let mut store = MockStorage::new();
let map = build_map();

Expand Down Expand Up @@ -927,7 +927,7 @@ mod test {
}

#[test]
fn range_composite_key_by_unique_index() {
fn range_raw_composite_key_by_unique_index() {
let mut store = MockStorage::new();
let map = build_map();

Expand Down Expand Up @@ -956,7 +956,7 @@ mod test {
}

#[test]
fn range_de_composite_key_by_unique_index() {
fn range_composite_key_by_unique_index() {
let mut store = MockStorage::new();
let map = build_map();

Expand Down Expand Up @@ -986,7 +986,7 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn range_de_simple_string_key() {
fn range_simple_string_key() {
let mut store = MockStorage::new();
let map = build_map();

Expand Down Expand Up @@ -1029,15 +1029,15 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn prefix_de_simple_string_key() {
fn prefix_simple_string_key() {
let mut store = MockStorage::new();
let map = build_map();

// save data
let (pks, datas) = save_data(&mut store, &map);

// Let's prefix and iterate.
// This is similar to calling range() directly, but added here for completeness / prefix_de
// This is similar to calling range() directly, but added here for completeness / prefix
// type checks
let all: StdResult<Vec<_>> = map
.prefix(())
Expand All @@ -1056,7 +1056,7 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn prefix_de_composite_key() {
fn prefix_composite_key() {
let mut store = MockStorage::new();

let indexes = DataCompositeMultiIndex {
Expand Down Expand Up @@ -1111,7 +1111,7 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn prefix_de_triple_key() {
fn prefix_triple_key() {
let mut store = MockStorage::new();

let indexes = DataCompositeMultiIndex {
Expand Down Expand Up @@ -1163,7 +1163,7 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn sub_prefix_de_triple_key() {
fn sub_prefix_triple_key() {
let mut store = MockStorage::new();

let indexes = DataCompositeMultiIndex {
Expand Down Expand Up @@ -1221,7 +1221,7 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn prefix_range_de_simple_key() {
fn prefix_range_simple_key() {
let mut store = MockStorage::new();

let indexes = DataCompositeMultiIndex {
Expand Down Expand Up @@ -1262,7 +1262,7 @@ mod test {
let pk4 = ("3", "5630");
map.save(&mut store, pk4, &data4).unwrap();

// let's try to iterate!
// let's prefix-range and iterate
let result: StdResult<Vec<_>> = map
.prefix_range(
&store,
Expand All @@ -1281,7 +1281,7 @@ mod test {
]
);

// let's try to iterate over a range
// let's try to iterate over a more restrictive prefix-range!
let result: StdResult<Vec<_>> = map
.prefix_range(
&store,
Expand All @@ -1302,7 +1302,7 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn prefix_range_de_triple_key() {
fn prefix_range_triple_key() {
let mut store = MockStorage::new();

let indexes = DataCompositeMultiIndex {
Expand Down
36 changes: 18 additions & 18 deletions packages/storage-plus/src/indexed_snapshot.rs
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ where
}
}

// short-cut for simple keys, rather than .prefix(()).range(...)
// short-cut for simple keys, rather than .prefix(()).range_raw(...)
impl<'a, K, T, I> IndexedSnapshotMap<'a, K, T, I>
where
K: PrimaryKey<'a> + Prefixer<'a> + KeyDeserialize,
Expand Down Expand Up @@ -488,7 +488,7 @@ mod test {
}

#[test]
fn range_simple_key_by_multi_index() {
fn range_raw_simple_key_by_multi_index() {
let mut store = MockStorage::new();
let map = build_snapshot_map();
let mut height = 1;
Expand Down Expand Up @@ -548,7 +548,7 @@ mod test {
}

#[test]
fn range_de_simple_key_by_multi_index() {
fn range_simple_key_by_multi_index() {
let mut store = MockStorage::new();
let map = build_snapshot_map();
let mut height = 1;
Expand Down Expand Up @@ -608,7 +608,7 @@ mod test {
}

#[test]
fn range_composite_key_by_multi_index() {
fn range_raw_composite_key_by_multi_index() {
let mut store = MockStorage::new();
let mut height = 2;

Expand Down Expand Up @@ -674,7 +674,7 @@ mod test {
}

#[test]
fn range_de_composite_key_by_multi_index() {
fn range_composite_key_by_multi_index() {
let mut store = MockStorage::new();
let mut height = 2;

Expand Down Expand Up @@ -853,7 +853,7 @@ mod test {
}

#[test]
fn range_simple_key_by_unique_index() {
fn range_raw_simple_key_by_unique_index() {
let mut store = MockStorage::new();
let map = build_snapshot_map();

Expand Down Expand Up @@ -884,7 +884,7 @@ mod test {
}

#[test]
fn range_de_simple_key_by_unique_index() {
fn range_simple_key_by_unique_index() {
let mut store = MockStorage::new();
let map = build_snapshot_map();

Expand Down Expand Up @@ -915,7 +915,7 @@ mod test {
}

#[test]
fn range_composite_key_by_unique_index() {
fn range_raw_composite_key_by_unique_index() {
let mut store = MockStorage::new();
let map = build_snapshot_map();

Expand Down Expand Up @@ -944,7 +944,7 @@ mod test {
}

#[test]
fn range_de_composite_key_by_unique_index() {
fn range_composite_key_by_unique_index() {
let mut store = MockStorage::new();
let map = build_snapshot_map();

Expand Down Expand Up @@ -974,7 +974,7 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn range_de_simple_string_key() {
fn range_simple_string_key() {
let mut store = MockStorage::new();
let map = build_snapshot_map();

Expand Down Expand Up @@ -1017,15 +1017,15 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn prefix_de_simple_string_key() {
fn prefix_simple_string_key() {
let mut store = MockStorage::new();
let map = build_snapshot_map();

// save data
let (pks, datas) = save_data(&mut store, &map);

// Let's prefix and iterate.
// This is similar to calling range() directly, but added here for completeness / prefix_de
// This is similar to calling range() directly, but added here for completeness / prefix
// type checks
let all: StdResult<Vec<_>> = map
.prefix(())
Expand All @@ -1044,15 +1044,15 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn sub_prefix_de_simple_string_key() {
fn sub_prefix_simple_string_key() {
let mut store = MockStorage::new();
let map = build_snapshot_map();

// save data
let (pks, datas) = save_data(&mut store, &map);

// Let's prefix and iterate.
// This is similar to calling range() directly, but added here for completeness / sub_prefix_de
// Let's sub-prefix and iterate.
// This is similar to calling range() directly, but added here for completeness / sub_prefix
// type checks
let all: StdResult<Vec<_>> = map
.sub_prefix(())
Expand All @@ -1071,7 +1071,7 @@ mod test {

#[test]
#[cfg(feature = "iterator")]
fn prefix_range_de_simple_key() {
fn prefix_range_simple_key() {
let mut store = MockStorage::new();

let indexes = DataCompositeMultiIndex {
Expand Down Expand Up @@ -1113,7 +1113,7 @@ mod test {
let pk4: (&str, &str) = ("3", "5630");
map.save(&mut store, pk4, &data4, 1).unwrap();

// let's try to iterate!
// let's prefix-range and iterate
let result: StdResult<Vec<_>> = map
.prefix_range(
&store,
Expand All @@ -1132,7 +1132,7 @@ mod test {
]
);

// let's try to iterate over a range
// let's try to iterate over a more restrictive prefix-range!
let result: StdResult<Vec<_>> = map
.prefix_range(
&store,
Expand Down

0 comments on commit 4181f54

Please sign in to comment.