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 : underlying_t { None = 0b0000'0000 , IncludeDate = 0b0000'0001 , DisableApiPriorV2 = 0b0000'0010 , All = IncludeDate | DisableApiPriorV2 }
using underlying_t = unsigned int

Public Member Functions

constexpr JsonOptions (underlying_t v) noexcept
constexpr JsonOptions (Values v) noexcept
constexpr operator underlying_t () 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

underlying_t value

Detailed Description

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

Definition at line 16 of file STBase.h.

Member Typedef Documentation

◆ underlying_t

using xrpl::JsonOptions::underlying_t = unsigned int

Definition at line 18 of file STBase.h.

Member Enumeration Documentation

◆ Values

Enumerator
None 
IncludeDate 
DisableApiPriorV2 
All 

Definition at line 21 of file STBase.h.

Constructor & Destructor Documentation

◆ JsonOptions() [1/2]

xrpl::JsonOptions::JsonOptions ( underlying_t v)
constexprnoexcept

Definition at line 30 of file STBase.h.

◆ JsonOptions() [2/2]

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

Definition at line 34 of file STBase.h.

Member Function Documentation

◆ operator underlying_t()

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

Definition at line 39 of file STBase.h.

◆ operator bool()

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

Definition at line 44 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 55 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 62 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 70 of file STBase.h.

Member Data Documentation

◆ value

underlying_t xrpl::JsonOptions::value

Definition at line 19 of file STBase.h.