rippled
Public Member Functions | Public Attributes | List of all members
ripple::StrandResult< TInAmt, TOutAmt > Struct Template Reference

Result of flow() execution of a single Strand. More...

Collaboration diagram for ripple::StrandResult< TInAmt, TOutAmt >:
Collaboration graph
[legend]

Public Member Functions

 StrandResult ()=default
 Strand result constructor. More...
 
 StrandResult (Strand const &strand, TInAmt const &in_, TOutAmt const &out_, PaymentSandbox &&sandbox_, boost::container::flat_set< uint256 > ofrsToRm_, bool inactive_)
 
 StrandResult (Strand const &strand, boost::container::flat_set< uint256 > ofrsToRm_)
 

Public Attributes

bool success
 Strand succeeded. More...
 
TInAmt in = beast::zero
 Currency amount in. More...
 
TOutAmt out = beast::zero
 Currency amount out. More...
 
std::optional< PaymentSandboxsandbox
 Resulting Sandbox state. More...
 
boost::container::flat_set< uint256ofrsToRm
 Offers to remove. More...
 
std::uint32_t ofrsUsed = 0
 
bool inactive = false
 Strand should not considered as a further source of liquidity (dry) More...
 

Detailed Description

template<class TInAmt, class TOutAmt>
struct ripple::StrandResult< TInAmt, TOutAmt >

Result of flow() execution of a single Strand.

Definition at line 45 of file StrandFlow.h.

Constructor & Destructor Documentation

◆ StrandResult() [1/3]

template<class TInAmt , class TOutAmt >
ripple::StrandResult< TInAmt, TOutAmt >::StrandResult ( )
default

Strand result constructor.

◆ StrandResult() [2/3]

template<class TInAmt , class TOutAmt >
ripple::StrandResult< TInAmt, TOutAmt >::StrandResult ( Strand const &  strand,
TInAmt const &  in_,
TOutAmt const &  out_,
PaymentSandbox &&  sandbox_,
boost::container::flat_set< uint256 ofrsToRm_,
bool  inactive_ 
)

Definition at line 63 of file StrandFlow.h.

◆ StrandResult() [3/3]

template<class TInAmt , class TOutAmt >
ripple::StrandResult< TInAmt, TOutAmt >::StrandResult ( Strand const &  strand,
boost::container::flat_set< uint256 ofrsToRm_ 
)

Definition at line 80 of file StrandFlow.h.

Member Data Documentation

◆ success

template<class TInAmt , class TOutAmt >
bool ripple::StrandResult< TInAmt, TOutAmt >::success

Strand succeeded.

Definition at line 47 of file StrandFlow.h.

◆ in

template<class TInAmt , class TOutAmt >
TInAmt ripple::StrandResult< TInAmt, TOutAmt >::in = beast::zero

Currency amount in.

Definition at line 48 of file StrandFlow.h.

◆ out

template<class TInAmt , class TOutAmt >
TOutAmt ripple::StrandResult< TInAmt, TOutAmt >::out = beast::zero

Currency amount out.

Definition at line 49 of file StrandFlow.h.

◆ sandbox

template<class TInAmt , class TOutAmt >
std::optional<PaymentSandbox> ripple::StrandResult< TInAmt, TOutAmt >::sandbox

Resulting Sandbox state.

Definition at line 50 of file StrandFlow.h.

◆ ofrsToRm

template<class TInAmt , class TOutAmt >
boost::container::flat_set<uint256> ripple::StrandResult< TInAmt, TOutAmt >::ofrsToRm

Offers to remove.

Definition at line 51 of file StrandFlow.h.

◆ ofrsUsed

template<class TInAmt , class TOutAmt >
std::uint32_t ripple::StrandResult< TInAmt, TOutAmt >::ofrsUsed = 0

Definition at line 54 of file StrandFlow.h.

◆ inactive

template<class TInAmt , class TOutAmt >
bool ripple::StrandResult< TInAmt, TOutAmt >::inactive = false

Strand should not considered as a further source of liquidity (dry)

Definition at line 57 of file StrandFlow.h.