rippled
Public Member Functions | List of all members
ripple::RawView Class Referenceabstract

Interface for ledger entry changes. More...

Inheritance diagram for ripple::RawView:
Inheritance graph
[legend]

Public Member Functions

virtual ~RawView ()=default
 
 RawView ()=default
 
 RawView (RawView const &)=default
 
RawViewoperator= (RawView const &)=delete
 
virtual void rawErase (std::shared_ptr< SLE > const &sle)=0
 Delete an existing state item. More...
 
virtual void rawInsert (std::shared_ptr< SLE > const &sle)=0
 Unconditionally insert a state item. More...
 
virtual void rawReplace (std::shared_ptr< SLE > const &sle)=0
 Unconditionally replace a state item. More...
 
virtual void rawDestroyXRP (XRPAmount const &fee)=0
 Destroy XRP. More...
 

Detailed Description

Interface for ledger entry changes.

Subclasses allow raw modification of ledger entries.

Definition at line 36 of file RawView.h.

Constructor & Destructor Documentation

◆ ~RawView()

virtual ripple::RawView::~RawView ( )
virtualdefault

◆ RawView() [1/2]

ripple::RawView::RawView ( )
default

◆ RawView() [2/2]

ripple::RawView::RawView ( RawView const &  )
default

Member Function Documentation

◆ operator=()

RawView& ripple::RawView::operator= ( RawView const &  )
delete

◆ rawErase()

virtual void ripple::RawView::rawErase ( std::shared_ptr< SLE > const &  sle)
pure virtual

Delete an existing state item.

The SLE is provided so the implementation can calculate metadata.

Implemented in ripple::OpenView, ripple::Ledger, and ripple::detail::ApplyViewBase.

◆ rawInsert()

virtual void ripple::RawView::rawInsert ( std::shared_ptr< SLE > const &  sle)
pure virtual

Unconditionally insert a state item.

Requirements: The key must not already exist.

Effects:

The key is associated with the SLE.
Note
The key is taken from the SLE

Implemented in ripple::OpenView, ripple::Ledger, and ripple::detail::ApplyViewBase.

◆ rawReplace()

virtual void ripple::RawView::rawReplace ( std::shared_ptr< SLE > const &  sle)
pure virtual

Unconditionally replace a state item.

Requirements:

The key must exist.

Effects:

The key is associated with the SLE.
Note
The key is taken from the SLE

Implemented in ripple::OpenView, ripple::Ledger, and ripple::detail::ApplyViewBase.

◆ rawDestroyXRP()

virtual void ripple::RawView::rawDestroyXRP ( XRPAmount const &  fee)
pure virtual

Destroy XRP.

This is used to pay for transaction fees.

Implemented in ripple::detail::ApplyViewBase, ripple::OpenView, and ripple::Ledger.