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

Container to concatenate an array. More...

#include <concatenate.hpp>

Public Member Functions

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

Related Functions

(Note that these are not member functions.)

concatenate_array concatenate (array::view_or_value array)
 Method to concatenate an array with a new array. More...
 

Detailed Description

Container to concatenate an array.

Use this with the array stream builder in order to pass an array into a new builder and append its values to the stream.

Member Function Documentation

◆ operator array::view()

bsoncxx::builder::concatenate_array::operator array::view ( ) const
inline

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

Returns
A view of the wrapped concatenate array.

◆ view()

array::view bsoncxx::builder::concatenate_array::view ( ) const
inline

Accessor that provides a view of the wrapped concatenate array.

Returns
A view of the wrapped concatenate array.

Friends And Related Function Documentation

◆ concatenate()

concatenate_array concatenate ( array::view_or_value  array)
related

Method to concatenate an array with a new array.

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

Parameters
arrayAn array to be concatenated.
Returns
concatenate_array A concatenating struct.

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