bsoncxx::builder::basic::document Class Reference

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

#include <document.hpp>

Inheritance diagram for bsoncxx::builder::basic::document:

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

Detailed Description

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

Member Function Documentation

extract()

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

inline

Transfer ownership of the underlying document to the caller.

Returns

A document::value with ownership of the document.

Warning

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

operator bsoncxx::document::view()

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

inline

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

Returns

A view of the current builder contents.

view()

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

inline

Returns

A view of the BSON document.

---

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

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