Soft-deprecated MerkleLeafIterator
This change updates the rustdoc for MerkleLeafIterator to include a line
about soft-deprecating the MerkleLeafIterator.
It may be fully deprecated in a future release.
@@ -591,8 +591,10 @@ impl MerkleRadixTree {
}
}
-// A MerkleLeafIterator is fixed to iterate over the state address/value pairs
-// the merkle root hash at the time of its creation.
+/// A MerkleLeafIterator is fixed to iterate over the state address/value pairs
+/// the merkle root hash at the time of its creation.
+///
+/// This struct is soft-deprecated, as it should not be directly referenced.
pub struct MerkleLeafIterator {
merkle_db: MerkleRadixTree,
visited: VecDeque<(String, Node)>,
