xrpl::Keylet Struct Reference

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

#include <Keylet.h>

Collaboration diagram for xrpl::Keylet:

Public Member Functions
	Keylet (LedgerEntryType type, uint256 const &key)
bool	check (STLedgerEntry const &) const
	Returns true if the SLE matches the type.

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 18 of file Keylet.h.

Constructor & Destructor Documentation

Keylet()

xrpl::Keylet::Keylet	(	LedgerEntryType	type,
		uint256 const &	key )

Definition at line 23 of file Keylet.h.

Member Function Documentation

check()

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

nodiscard

Returns true if the SLE matches the type.

Definition at line 10 of file Keylet.cpp.

Member Data Documentation

key

uint256 xrpl::Keylet::key

Definition at line 20 of file Keylet.h.

type

LedgerEntryType xrpl::Keylet::type

Definition at line 21 of file Keylet.h.