rippled
Public Member Functions | Public Attributes | List of all members
ripple::Keylet Struct Reference

A pair of SHAMap key and LedgerEntryType. More...

Collaboration diagram for ripple::Keylet:
Collaboration graph
[legend]

Public Member Functions

 Keylet (LedgerEntryType type_, uint256 const &key_)
 
bool check (STLedgerEntry const &) const
 Returns true if the SLE matches the type. More...
 

Public Attributes

uint256 key
 
LedgerEntryType type
 

Detailed Description

A pair of SHAMap key and LedgerEntryType.

A Keylet identifies both a key in the state map and its ledger entry type.

Note
Keylet is a portmanteau of the words key and LET, an acronym for LedgerEntryType.

Definition at line 38 of file Keylet.h.

Constructor & Destructor Documentation

◆ Keylet()

ripple::Keylet::Keylet ( LedgerEntryType  type_,
uint256 const &  key_ 
)

Definition at line 43 of file Keylet.h.

Member Function Documentation

◆ check()

bool ripple::Keylet::check ( STLedgerEntry const &  sle) const

Returns true if the SLE matches the type.

Definition at line 26 of file Keylet.cpp.

Member Data Documentation

◆ key

uint256 ripple::Keylet::key

Definition at line 40 of file Keylet.h.

◆ type

LedgerEntryType ripple::Keylet::type

Definition at line 41 of file Keylet.h.