bsoncxx::v_noabi::types::bson_value::view Class Reference

#include <bsoncxx/v_noabi/bsoncxx/types/bson_value/view.hpp>

Description

A view-only variant that can contain any BSON type.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

Public Member Functions
	view () noexcept
	Default constructs a bson_value::view. The resulting view will be initialized to point at a bson_value of type k_null.
const b_array &	get_array () const
	Returns the underlying BSON array value.
const b_binary &	get_binary () const
	Returns the underlying BSON binary data value.
const b_bool &	get_bool () const
	Returns the underlying BSON boolean value.
const b_code &	get_code () const
	Returns the underlying BSON JavaScript code value.
const b_codewscope &	get_codewscope () const
	Returns the underlying BSON JavaScript code with scope value.
const b_date &	get_date () const
	Returns the underlying BSON date value.
const b_dbpointer &	get_dbpointer () const
	Returns the underlying BSON DBPointer value.
const b_decimal128 &	get_decimal128 () const
	Returns the underlying BSON Decimal128 value.
const b_document &	get_document () const
	Returns the underlying BSON document value.
const b_double &	get_double () const
	Returns the underlying BSON double value.
const b_int32 &	get_int32 () const
	Returns the underlying BSON 32-bit signed integer value.
const b_int64 &	get_int64 () const
	Returns the underlying BSON 64-bit signed integer value.
const b_maxkey &	get_maxkey () const
	Returns the underlying BSON max-key value.
const b_minkey &	get_minkey () const
	Returns the underlying BSON min-key value.
const b_null &	get_null () const
	Returns the underlying BSON null value.
const b_oid &	get_oid () const
	Returns the underlying BSON ObjectId value.
const b_regex &	get_regex () const
	Returns the underlying BSON regex value.
const b_string &	get_string () const
	Returns the underlying BSON UTF-8 string value.
const b_symbol &	get_symbol () const
	Returns the underlying BSON symbol value.
const b_timestamp &	get_timestamp () const
	Returns the underlying BSON replication timestamp value.
const b_undefined &	get_undefined () const
	Returns the underlying BSON undefined value.
BSONCXX_DEPRECATED const b_string &	get_utf8 () const
	Returns the underlying BSON UTF-8 string value.
bsoncxx::v_noabi::type	type () const
	Returns the type of the underlying BSON value stored in this object.
	view (b_double v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_string v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_document v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_array v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_binary v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_undefined v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_oid v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_bool v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_date v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_null v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_regex v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_dbpointer v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_code v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_symbol v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_codewscope v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_int32 v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_timestamp v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_int64 v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_decimal128 v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_maxkey v) noexcept
	Construct a bson_value::view from the provided BSON type.
	view (b_minkey v) noexcept
	Construct a bson_value::view from the provided BSON type.

Related Symbols
(Note that these are not member symbols.)
bool	operator== (const bson_value::view &, const bson_value::view &)
	Compare two bson_value::views for equality.
bool	operator!= (const bson_value::view &, const bson_value::view &)
	Compare two bson_value::views for equality.
template<typename T >
detail::requires_t< bool, is_bson_view_compatible< T > >	operator== (const bson_value::view &lhs, T &&rhs)
	Compares a view with a type representable as a view.
template<typename T >
detail::requires_t< bool, is_bson_view_compatible< T > >	operator== (T &&lhs, const bson_value::view &rhs)
	Compares a view with a type representable as a view.
template<typename T >
detail::requires_t< bool, is_bson_view_compatible< T > >	operator!= (const bson_value::view &lhs, T &&rhs)
	Compares a view with a type representable as a view.
template<typename T >
detail::requires_t< bool, is_bson_view_compatible< T > >	operator!= (T &&lhs, const bson_value::view &rhs)
	Compares a view with a type representable as a view.

Constructor & Destructor Documentation

view() [1/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_double v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [2/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_string v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [3/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_document v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [4/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_array v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [5/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_binary v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [6/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_undefined v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [7/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_oid v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [8/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_bool v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [9/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_date v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [10/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_null v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [11/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_regex v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [12/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_dbpointer v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [13/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_code v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [14/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_symbol v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [15/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_codewscope v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [16/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_int32 v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [17/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_timestamp v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [18/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_int64 v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [19/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_decimal128 v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [20/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_maxkey v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [21/22]

bsoncxx::v_noabi::types::bson_value::view::view ( b_minkey v )

explicitnoexcept

Construct a bson_value::view from the provided BSON type.

view() [22/22]

bsoncxx::v_noabi::types::bson_value::view::view ( )

noexcept

Default constructs a bson_value::view. The resulting view will be initialized to point at a bson_value of type k_null.

Member Function Documentation

get_array()

const b_array & bsoncxx::v_noabi::types::bson_value::view::get_array

(

)

const

Returns the underlying BSON array value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_binary()

const b_binary & bsoncxx::v_noabi::types::bson_value::view::get_binary

(

)

const

Returns the underlying BSON binary data value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_bool()

const b_bool & bsoncxx::v_noabi::types::bson_value::view::get_bool

(

)

const

Returns the underlying BSON boolean value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_code()

const b_code & bsoncxx::v_noabi::types::bson_value::view::get_code

(

)

const

Returns the underlying BSON JavaScript code value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_codewscope()

const b_codewscope & bsoncxx::v_noabi::types::bson_value::view::get_codewscope

(

)

const

Returns the underlying BSON JavaScript code with scope value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_date()

const b_date & bsoncxx::v_noabi::types::bson_value::view::get_date

(

)

const

Returns the underlying BSON date value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_dbpointer()

const b_dbpointer & bsoncxx::v_noabi::types::bson_value::view::get_dbpointer

(

)

const

Returns the underlying BSON DBPointer value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_decimal128()

const b_decimal128 & bsoncxx::v_noabi::types::bson_value::view::get_decimal128

(

)

const

Returns the underlying BSON Decimal128 value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_document()

const b_document & bsoncxx::v_noabi::types::bson_value::view::get_document

(

)

const

Returns the underlying BSON document value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_double()

const b_double & bsoncxx::v_noabi::types::bson_value::view::get_double

(

)

const

Returns the underlying BSON double value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_int32()

const b_int32 & bsoncxx::v_noabi::types::bson_value::view::get_int32

(

)

const

Returns the underlying BSON 32-bit signed integer value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_int64()

const b_int64 & bsoncxx::v_noabi::types::bson_value::view::get_int64

(

)

const

Returns the underlying BSON 64-bit signed integer value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_maxkey()

const b_maxkey & bsoncxx::v_noabi::types::bson_value::view::get_maxkey

(

)

const

Returns the underlying BSON max-key value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_minkey()

const b_minkey & bsoncxx::v_noabi::types::bson_value::view::get_minkey

(

)

const

Returns the underlying BSON min-key value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_null()

const b_null & bsoncxx::v_noabi::types::bson_value::view::get_null

(

)

const

Returns the underlying BSON null value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_oid()

const b_oid & bsoncxx::v_noabi::types::bson_value::view::get_oid

(

)

const

Returns the underlying BSON ObjectId value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_regex()

const b_regex & bsoncxx::v_noabi::types::bson_value::view::get_regex

(

)

const

Returns the underlying BSON regex value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_string()

const b_string & bsoncxx::v_noabi::types::bson_value::view::get_string

(

)

const

Returns the underlying BSON UTF-8 string value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_symbol()

const b_symbol & bsoncxx::v_noabi::types::bson_value::view::get_symbol

(

)

const

Returns the underlying BSON symbol value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_timestamp()

const b_timestamp & bsoncxx::v_noabi::types::bson_value::view::get_timestamp

(

)

const

Returns the underlying BSON replication timestamp value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_undefined()

const b_undefined & bsoncxx::v_noabi::types::bson_value::view::get_undefined

(

)

const

Returns the underlying BSON undefined value.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

get_utf8()

BSONCXX_DEPRECATED const b_string & bsoncxx::v_noabi::types::bson_value::view::get_utf8

(

)

const

Returns the underlying BSON UTF-8 string value.

Deprecated

use get_string instead.

Warning

Calling the wrong get_<type> method will cause an exception to be thrown.

type()

bsoncxx::v_noabi::type bsoncxx::v_noabi::types::bson_value::view::type

(

)

const

Returns the type of the underlying BSON value stored in this object.

Friends And Related Symbol Documentation

operator!= [1/3]

bool operator!= ( const bson_value::view & , const bson_value::view &  )

friend

Compare two bson_value::views for equality.

operator!=() [2/3]

template<typename T >

detail::requires_t< bool, is_bson_view_compatible< T > > operator!= ( const bson_value::view & lhs, T && rhs )

related

Compares a view with a type representable as a view.

Constraints

• bsoncxx::v_noabi::types::bson_value::view is constructible from T.

operator!=() [3/3]

template<typename T >

detail::requires_t< bool, is_bson_view_compatible< T > > operator!= ( T && lhs, const bson_value::view & rhs )

related

Compares a view with a type representable as a view.

Constraints

• bsoncxx::v_noabi::types::bson_value::view is constructible from T.

operator== [1/3]

bool operator== ( const bson_value::view & , const bson_value::view &  )

friend

Compare two bson_value::views for equality.

operator==() [2/3]

template<typename T >

detail::requires_t< bool, is_bson_view_compatible< T > > operator== ( const bson_value::view & lhs, T && rhs )

related

Compares a view with a type representable as a view.

Constraints

• bsoncxx::v_noabi::types::bson_value::view is constructible from T.

operator==() [3/3]

template<typename T >

detail::requires_t< bool, is_bson_view_compatible< T > > operator== ( T && lhs, const bson_value::view & rhs )

related

Compares a view with a type representable as a view.

Constraints

• bsoncxx::v_noabi::types::bson_value::view is constructible from T.

---

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

• bsoncxx/v_noabi/bsoncxx/types/bson_value/view.hpp