xrpld
Loading...
Searching...
No Matches
xrpl::JsonOptions Struct Reference

Note, should be treated as flags that can be | and &. More...

#include <STBase.h>

Public Types

enum class  Values : UnderlyingT { None = 0b0000'0000 , IncludeDate = 0b0000'0001 , DisableApiPriorV2 = 0b0000'0010 , All = IncludeDate | DisableApiPriorV2 }
using UnderlyingT = unsigned int

Public Member Functions

constexpr JsonOptions (UnderlyingT v) noexcept
constexpr JsonOptions (Values v) noexcept
constexpr operator UnderlyingT () const noexcept
constexpr operator bool () const noexcept
constexpr auto friend operator== (JsonOptions lh, JsonOptions rh) noexcept -> bool=default
constexpr auto friend operator!= (JsonOptions lh, JsonOptions rh) noexcept -> bool=default
constexpr JsonOptions friend operator| (JsonOptions lh, JsonOptions rh) noexcept
 Returns JsonOptions union of lh and rh.
constexpr JsonOptions friend operator& (JsonOptions lh, JsonOptions rh) noexcept
 Returns JsonOptions intersection of lh and rh.
constexpr JsonOptions friend operator~ (JsonOptions v) noexcept
 Returns JsonOptions binary negation, can be used with & (above) for set difference e.g.

Public Attributes

UnderlyingT value

Detailed Description

Note, should be treated as flags that can be | and &.

Definition at line 21 of file STBase.h.

Member Typedef Documentation

◆ UnderlyingT

using xrpl::JsonOptions::UnderlyingT = unsigned int

Definition at line 23 of file STBase.h.

Member Enumeration Documentation

◆ Values

Enumerator
None 
IncludeDate 
DisableApiPriorV2 
All 

Definition at line 26 of file STBase.h.

Constructor & Destructor Documentation

◆ JsonOptions() [1/2]

xrpl::JsonOptions::JsonOptions ( UnderlyingT v)
constexprnoexcept

Definition at line 35 of file STBase.h.

◆ JsonOptions() [2/2]

xrpl::JsonOptions::JsonOptions ( Values v)
constexprnoexcept

Definition at line 39 of file STBase.h.

Member Function Documentation

◆ operator UnderlyingT()

xrpl::JsonOptions::operator UnderlyingT ( ) const
explicitnodiscardconstexprnoexcept

Definition at line 44 of file STBase.h.

◆ operator bool()

xrpl::JsonOptions::operator bool ( ) const
explicitnodiscardconstexprnoexcept

Definition at line 49 of file STBase.h.

◆ operator==()

auto friend xrpl::JsonOptions::operator== ( JsonOptions lh,
JsonOptions rh ) -> bool=default
nodiscardconstexprdefaultnoexcept

◆ operator!=()

auto friend xrpl::JsonOptions::operator!= ( JsonOptions lh,
JsonOptions rh ) -> bool=default
nodiscardconstexprdefaultnoexcept

◆ operator|()

JsonOptions friend xrpl::JsonOptions::operator| ( JsonOptions lh,
JsonOptions rh )
nodiscardconstexprnoexcept

Returns JsonOptions union of lh and rh.

Definition at line 62 of file STBase.h.

◆ operator&()

JsonOptions friend xrpl::JsonOptions::operator& ( JsonOptions lh,
JsonOptions rh )
nodiscardconstexprnoexcept

Returns JsonOptions intersection of lh and rh.

Definition at line 71 of file STBase.h.

◆ operator~()

JsonOptions friend xrpl::JsonOptions::operator~ ( JsonOptions v)
nodiscardconstexprnoexcept

Returns JsonOptions binary negation, can be used with & (above) for set difference e.g.

(options & ~JsonOptions::kIncludeDate)

Definition at line 81 of file STBase.h.

Member Data Documentation

◆ value

UnderlyingT xrpl::JsonOptions::value

Definition at line 24 of file STBase.h.