mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-19 10:35:50 +00:00
1d42c4f6de
Per XLS-0095, we are taking steps to rename ripple(d) to xrpl(d). This change specifically removes all copyright notices referencing Ripple, XRPLF, and certain affiliated contributors upon mutual agreement, so the notice in the LICENSE.md file applies throughout. Copyright notices referencing external contributions remain as-is. Duplicate verbiage is also removed.
114 lines
2.2 KiB
C++
114 lines
2.2 KiB
C++
#ifndef XRPL_LEDGER_DIR_H_INCLUDED
|
|
#define XRPL_LEDGER_DIR_H_INCLUDED
|
|
|
|
#include <xrpl/ledger/ReadView.h>
|
|
#include <xrpl/protocol/Indexes.h>
|
|
|
|
namespace ripple {
|
|
|
|
/** A class that simplifies iterating ledger directory pages
|
|
|
|
The Dir class provides a forward iterator for walking through
|
|
the uint256 values contained in ledger directories.
|
|
|
|
The Dir class also allows accelerated directory walking by
|
|
stepping directly from one page to the next using the next_page()
|
|
member function.
|
|
|
|
As of July 2024, the Dir class is only being used with NFTokenOffer
|
|
directories and for unit tests.
|
|
*/
|
|
class Dir
|
|
{
|
|
private:
|
|
ReadView const* view_ = nullptr;
|
|
Keylet root_;
|
|
std::shared_ptr<SLE const> sle_;
|
|
STVector256 const* indexes_ = nullptr;
|
|
|
|
public:
|
|
class const_iterator;
|
|
using value_type = std::shared_ptr<SLE const>;
|
|
|
|
Dir(ReadView const&, Keylet const&);
|
|
|
|
const_iterator
|
|
begin() const;
|
|
|
|
const_iterator
|
|
end() const;
|
|
};
|
|
|
|
class Dir::const_iterator
|
|
{
|
|
public:
|
|
using value_type = Dir::value_type;
|
|
using pointer = value_type const*;
|
|
using reference = value_type const&;
|
|
using difference_type = std::ptrdiff_t;
|
|
using iterator_category = std::forward_iterator_tag;
|
|
|
|
bool
|
|
operator==(const_iterator const& other) const;
|
|
|
|
bool
|
|
operator!=(const_iterator const& other) const
|
|
{
|
|
return !(*this == other);
|
|
}
|
|
|
|
reference
|
|
operator*() const;
|
|
|
|
pointer
|
|
operator->() const
|
|
{
|
|
return &**this;
|
|
}
|
|
|
|
const_iterator&
|
|
operator++();
|
|
|
|
const_iterator
|
|
operator++(int);
|
|
|
|
const_iterator&
|
|
next_page();
|
|
|
|
std::size_t
|
|
page_size();
|
|
|
|
Keylet const&
|
|
page() const
|
|
{
|
|
return page_;
|
|
}
|
|
|
|
uint256
|
|
index() const
|
|
{
|
|
return index_;
|
|
}
|
|
|
|
private:
|
|
friend class Dir;
|
|
|
|
const_iterator(ReadView const& view, Keylet const& root, Keylet const& page)
|
|
: view_(&view), root_(root), page_(page)
|
|
{
|
|
}
|
|
|
|
ReadView const* view_ = nullptr;
|
|
Keylet root_;
|
|
Keylet page_;
|
|
uint256 index_;
|
|
std::optional<value_type> mutable cache_;
|
|
std::shared_ptr<SLE const> sle_;
|
|
STVector256 const* indexes_ = nullptr;
|
|
std::vector<uint256>::const_iterator it_;
|
|
};
|
|
|
|
} // namespace ripple
|
|
|
|
#endif
|