rippled
Classes | Functions | Variables
ripple::keylet Namespace Reference

Keylet computation funclets. More...

Classes

struct  account_t
 AccountID root. More...
 
struct  amendments_t
 The amendment table. More...
 
struct  book_t
 The beginning of an order book. More...
 
struct  check_t
 A Check. More...
 
struct  depositPreauth_t
 A DepositPreauth. More...
 
struct  fees_t
 The ledger fees. More...
 
struct  line_t
 A trust line. More...
 
struct  next_t
 The directory for the next lower quality. More...
 
struct  offer_t
 An offer from an account. More...
 
struct  quality_t
 The initial directory page for a specific quality. More...
 
struct  signers_t
 A SignerList. More...
 
struct  skip_t
 Skip list. More...
 
struct  ticket_t
 A ticket belonging to an account. More...
 

Functions

Keylet child (uint256 const &key)
 Any item that can be in an owner dir. More...
 
Keylet unchecked (uint256 const &key)
 Any ledger entry. More...
 
Keylet ownerDir (AccountID const &id)
 The root page of an account's directory. More...
 
Keylet escrow (AccountID const &source, std::uint32_t seq)
 An escrow entry. More...
 
Keylet payChan (AccountID const &source, AccountID const &dst, std::uint32_t seq)
 A PaymentChannel. More...
 
Keylet page (uint256 const &key)
 

Variables

static const account_t account {}
 
static const amendments_t amendments {}
 
static const skip_t skip {}
 
static const fees_t fees {}
 
static const book_t book {}
 
static const line_t line {}
 
static const offer_t offer {}
 
static const quality_t quality {}
 
static const next_t next {}
 
static const ticket_t ticket {}
 
static const signers_t signers {}
 
static const check_t check {}
 
static const depositPreauth_t depositPreauth {}
 

Detailed Description

Keylet computation funclets.

Function Documentation

◆ child()

Keylet ripple::keylet::child ( uint256 const &  key)

Any item that can be in an owner dir.

Definition at line 191 of file Indexes.cpp.

◆ unchecked()

Keylet ripple::keylet::unchecked ( uint256 const &  key)

Any ledger entry.

Definition at line 290 of file Indexes.cpp.

◆ ownerDir()

Keylet ripple::keylet::ownerDir ( AccountID const &  id)

The root page of an account's directory.

Definition at line 296 of file Indexes.cpp.

◆ page() [1/3]

Keylet ripple::keylet::page ( uint256 const &  key,
std::uint64_t  index 
)

A page in a directory.

Definition at line 302 of file Indexes.cpp.

◆ page() [2/3]

Keylet ripple::keylet::page ( Keylet const &  root,
std::uint64_t  index 
)

Definition at line 308 of file Indexes.cpp.

◆ escrow()

Keylet ripple::keylet::escrow ( AccountID const &  source,
std::uint32_t  seq 
)

An escrow entry.

Definition at line 315 of file Indexes.cpp.

◆ payChan()

Keylet ripple::keylet::payChan ( AccountID const &  source,
AccountID const &  dst,
std::uint32_t  seq 
)

A PaymentChannel.

Definition at line 326 of file Indexes.cpp.

◆ page() [3/3]

Keylet ripple::keylet::page ( uint256 const &  key)

Definition at line 312 of file Indexes.h.

Variable Documentation

◆ account

const account_t ripple::keylet::account {}
static

Definition at line 120 of file Indexes.h.

◆ amendments

const amendments_t ripple::keylet::amendments {}
static

Definition at line 130 of file Indexes.h.

◆ skip

const skip_t ripple::keylet::skip {}
static

Definition at line 147 of file Indexes.h.

◆ fees

const fees_t ripple::keylet::fees {}
static

Definition at line 158 of file Indexes.h.

◆ book

const book_t ripple::keylet::book {}
static

Definition at line 168 of file Indexes.h.

◆ line

const line_t ripple::keylet::line {}
static

Definition at line 190 of file Indexes.h.

◆ offer

const offer_t ripple::keylet::offer {}
static

Definition at line 206 of file Indexes.h.

◆ quality

const quality_t ripple::keylet::quality {}
static

Definition at line 216 of file Indexes.h.

◆ next

const next_t ripple::keylet::next {}
static

Definition at line 226 of file Indexes.h.

◆ ticket

const ticket_t ripple::keylet::ticket {}
static

Definition at line 242 of file Indexes.h.

◆ signers

const signers_t ripple::keylet::signers {}
static

Definition at line 258 of file Indexes.h.

◆ check

const check_t ripple::keylet::check {}
static

Definition at line 274 of file Indexes.h.

◆ depositPreauth

const depositPreauth_t ripple::keylet::depositPreauth {}
static

Definition at line 290 of file Indexes.h.