mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-19 18:45:52 +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.6 KiB
C++
114 lines
2.6 KiB
C++
#ifndef XRPL_PROTOCOL_STLEDGERENTRY_H_INCLUDED
|
|
#define XRPL_PROTOCOL_STLEDGERENTRY_H_INCLUDED
|
|
|
|
#include <xrpl/protocol/Indexes.h>
|
|
#include <xrpl/protocol/STObject.h>
|
|
|
|
namespace ripple {
|
|
|
|
class Rules;
|
|
namespace test {
|
|
class Invariants_test;
|
|
}
|
|
|
|
class STLedgerEntry final : public STObject, public CountedObject<STLedgerEntry>
|
|
{
|
|
uint256 key_;
|
|
LedgerEntryType type_;
|
|
|
|
public:
|
|
using pointer = std::shared_ptr<STLedgerEntry>;
|
|
using ref = std::shared_ptr<STLedgerEntry> const&;
|
|
using const_pointer = std::shared_ptr<STLedgerEntry const>;
|
|
using const_ref = std::shared_ptr<STLedgerEntry const> const&;
|
|
|
|
/** Create an empty object with the given key and type. */
|
|
explicit STLedgerEntry(Keylet const& k);
|
|
STLedgerEntry(LedgerEntryType type, uint256 const& key);
|
|
STLedgerEntry(SerialIter& sit, uint256 const& index);
|
|
STLedgerEntry(SerialIter&& sit, uint256 const& index);
|
|
STLedgerEntry(STObject const& object, uint256 const& index);
|
|
|
|
SerializedTypeID
|
|
getSType() const override;
|
|
|
|
std::string
|
|
getFullText() const override;
|
|
|
|
std::string
|
|
getText() const override;
|
|
|
|
Json::Value
|
|
getJson(JsonOptions options = JsonOptions::none) const override;
|
|
|
|
/** Returns the 'key' (or 'index') of this item.
|
|
The key identifies this entry's position in
|
|
the SHAMap associative container.
|
|
*/
|
|
uint256 const&
|
|
key() const;
|
|
|
|
LedgerEntryType
|
|
getType() const;
|
|
|
|
// is this a ledger entry that can be threaded
|
|
bool
|
|
isThreadedType(Rules const& rules) const;
|
|
|
|
bool
|
|
thread(
|
|
uint256 const& txID,
|
|
std::uint32_t ledgerSeq,
|
|
uint256& prevTxID,
|
|
std::uint32_t& prevLedgerID);
|
|
|
|
private:
|
|
/* Make STObject comply with the template for this SLE type
|
|
Can throw
|
|
*/
|
|
void
|
|
setSLEType();
|
|
|
|
friend test::Invariants_test; // this test wants access to the private
|
|
// type_
|
|
|
|
STBase*
|
|
copy(std::size_t n, void* buf) const override;
|
|
STBase*
|
|
move(std::size_t n, void* buf) override;
|
|
|
|
friend class detail::STVar;
|
|
};
|
|
|
|
using SLE = STLedgerEntry;
|
|
|
|
inline STLedgerEntry::STLedgerEntry(LedgerEntryType type, uint256 const& key)
|
|
: STLedgerEntry(Keylet(type, key))
|
|
{
|
|
}
|
|
|
|
inline STLedgerEntry::STLedgerEntry(SerialIter&& sit, uint256 const& index)
|
|
: STLedgerEntry(sit, index)
|
|
{
|
|
}
|
|
|
|
/** Returns the 'key' (or 'index') of this item.
|
|
The key identifies this entry's position in
|
|
the SHAMap associative container.
|
|
*/
|
|
inline uint256 const&
|
|
STLedgerEntry::key() const
|
|
{
|
|
return key_;
|
|
}
|
|
|
|
inline LedgerEntryType
|
|
STLedgerEntry::getType() const
|
|
{
|
|
return type_;
|
|
}
|
|
|
|
} // namespace ripple
|
|
|
|
#endif
|