MongoDB C++ Driver  mongocxx-3.4.0
Public Member Functions | Related Functions | List of all members
bsoncxx::builder::concatenate_doc Struct Reference

Container to concatenate a document. More...

#include <concatenate.hpp>

Public Member Functions

 operator document::view () const
 Conversion operator that provides a view of the wrapped concatenate document. More...
 
document::view view () const
 Accessor that provides a view of the wrapped concatenate document. More...
 

Related Functions

(Note that these are not member functions.)

concatenate_doc concatenate (document::view_or_value doc)
 Helper method to concatenate a document. More...
 

Detailed Description

Container to concatenate a document.

Use it by constructing an instance with the document to be concatenated, and pass it into a document stream builder.

Member Function Documentation

◆ operator document::view()

bsoncxx::builder::concatenate_doc::operator document::view ( ) const
inline

Conversion operator that provides a view of the wrapped concatenate document.

Returns
A view of the wrapped concatenate document.

◆ view()

document::view bsoncxx::builder::concatenate_doc::view ( ) const
inline

Accessor that provides a view of the wrapped concatenate document.

Returns
A view of the wrapped concatenate document.

Friends And Related Function Documentation

◆ concatenate()

concatenate_doc concatenate ( document::view_or_value  doc)
related

Helper method to concatenate a document.

Use this with the document stream builder to merge an existing document's fields with a new document's.

Parameters
docA document to be concatenated.
Returns
concatenate_doc A concatenating struct.

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