qyriad/miden-crypto
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

document the direction of iteration

Browse source
This commit is contained in:
Grzegorz Świrski 2025-05-03 20:54:00 +02:00
parent d3e70cf58b
commit e405f58ef5
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
miden-crypto/src/merkle/sparse_path.rs
View file

@ -103,6 +103,7 @@ impl SparseMerklePath {
// ============================================================================================ // ============================================================================================
/// Constructs a borrowing iterator over the nodes in this path. /// Constructs a borrowing iterator over the nodes in this path.
/// Starts from the leaf and iterates toward the root (excluding root).
pub fn iter(&self) -> impl ExactSizeIterator<Item = RpoDigest> { pub fn iter(&self) -> impl ExactSizeIterator<Item = RpoDigest> {
self.into_iter() self.into_iter()
} }
@ -196,7 +197,8 @@ impl From<SparseMerklePath> for Vec<RpoDigest> {
// ITERATORS // ITERATORS
// ================================================================================================ // ================================================================================================
/// Iterator for [`SparseMerklePath`]. /// Iterator for [`SparseMerklePath`]. Starts from the leaf and iterates toward the root (excluding
/// root).
pub struct SparseMerklePathIter<'p> { pub struct SparseMerklePathIter<'p> {
/// The "inner" value we're iterating over. /// The "inner" value we're iterating over.
path: Cow<'p, SparseMerklePath>, path: Cow<'p, SparseMerklePath>,