bsoncxx::builder::basic::array Class Reference

A traditional builder-style interface for constructing a BSON array. More...

#include <array.hpp>

Inheritance diagram for bsoncxx::builder::basic::array:

Public Member Functions
	array ()
	Default constructor.
	array (array &&arr) noexcept
	Move constructor.
array &	operator= (array &&arr) noexcept
	Move assignment operator.
bsoncxx::array::view	view () const
	operator bsoncxx::array::view () const
	Conversion operator that provides a view of the current builder contents. More...
bsoncxx::array::value	extract ()
	Transfer ownership of the underlying array to the caller. More...
void	clear ()
	Reset the underlying BSON to an empty array.
Public Member Functions inherited from bsoncxx::builder::basic::sub_array
	sub_array (core *core)
	Default constructor.
template<typename Arg , typename... Args>
void	append (Arg &&a, Args &&... args)
	Appends multiple BSON values.
void	append ()
	Inductive base-case for the variadic append(...)

Detailed Description

A traditional builder-style interface for constructing a BSON array.

Member Function Documentation

extract()

bsoncxx::array::value bsoncxx::builder::basic::array::extract ( )

inline

Transfer ownership of the underlying array to the caller.

Returns

An array::value with ownership of the array.

Warning

After calling extract() it is illegal to call any methods on this class, unless it is subsequenly moved into.

operator bsoncxx::array::view()

bsoncxx::builder::basic::array::operator bsoncxx::array::view ( ) const

inline

Conversion operator that provides a view of the current builder contents.

Returns

A view of the current builder contents.

view()

bsoncxx::array::view bsoncxx::builder::basic::array::view ( ) const

inline

Returns

A view of the BSON array.

---

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

• src/bsoncxx/builder/basic/array.hpp