MongoDB C++ Driver  mongocxx-3.4.0
Public Member Functions | List of all members
bsoncxx::decimal128 Class Reference

Represents an IEEE 754-2008 BSON Decimal128 value in a platform-independent way. More...

#include <decimal128.hpp>

Public Member Functions

 decimal128 ()=default
 Constructs a BSON Decimal128 value representing zero.
 
 decimal128 (uint64_t high, uint64_t low) noexcept
 Constructs a BSON Decimal128 from high and low 64-bit big-endian parts. More...
 
 decimal128 (stdx::string_view str)
 Constructs a BSON Decimal128 from a string. More...
 
std::string to_string () const
 Converts this decimal128 value to a string representation. More...
 
uint64_t high () const
 Accessor for high 64 bits.
 
uint64_t low () const
 Accessor for low 64 bits.
 
bool operator== (const decimal128 &lhs, const decimal128 &rhs)
 Relational operators for decimal128.
 
bool operator!= (const decimal128 &lhs, const decimal128 &rhs)
 Relational operators for decimal128.
 

Detailed Description

Represents an IEEE 754-2008 BSON Decimal128 value in a platform-independent way.

Constructor & Destructor Documentation

◆ decimal128() [1/2]

bsoncxx::decimal128::decimal128 ( uint64_t  high,
uint64_t  low 
)
inlinenoexcept

Constructs a BSON Decimal128 from high and low 64-bit big-endian parts.

Parameters
highThe high 64-bits.
lowThe low 64-bits.

◆ decimal128() [2/2]

bsoncxx::decimal128::decimal128 ( stdx::string_view  str)
explicit

Constructs a BSON Decimal128 from a string.

Parameters
strA string representation of a decimal number.
Exceptions
bsoncxx::exceptionif the string isn't a valid BSON Decimal128 representation.

Member Function Documentation

◆ to_string()

std::string bsoncxx::decimal128::to_string ( ) const

Converts this decimal128 value to a string representation.

Returns
A string representation of a IEEE 754-2008 decimal number.

The documentation for this class was generated from the following file: