MongoDB C++ Driver  mongocxx-3.4.0
Public Member Functions | List of all members
bsoncxx::builder::stream::array Class Reference

A streaming interface for constructing a BSON array. More...

#include <array.hpp>

+ Inheritance diagram for bsoncxx::builder::stream::array:

Public Member Functions

 array ()
 Default constructor.
 
bsoncxx::array::view view () const
 
 operator bsoncxx::array::view () const
 
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::stream::array_context<>
 array_context (core *core)
 Create an array_context given a core builder. More...
 
std::enable_if< !(util::is_functor< T, void(array_context<>)>::value||util::is_functor< T, void(single_context)>::value||std::is_same< typename std::remove_reference< T >::type, const finalize_type >::value), array_context >::typeoperator<< (T &&t)
 << operator for accepting a real value and appending it to the core builder. More...
 
std::enable_if<(util::is_functor< Func, void(array_context<>)>::value||util::is_functor< Func, void(single_context)>::value), array_context >::typeoperator<< (Func &&func)
 << operator for accepting a callable of the form void(array_context) or void(single_context) and invoking it to perform 1 or more value appends to the core builder. More...
 
std::enable_if< std::is_same< closed_context, closed_context >::value &&std::is_same< typename std::remove_reference< T >::type, const finalize_type >::value, bsoncxx::array::value >::type operator<< (T &&)
 << operator for finalizing the stream. More...
 
key_context< array_contextoperator<< (const open_document_type)
 << operator for opening a new subdocument in the core builder. More...
 
array_context operator<< (concatenate_array array)
 << operator for concatenating another array. More...
 
array_context< array_contextoperator<< (const open_array_type)
 << operator for opening a new subarray in the core builder. More...
 
closed_context operator<< (const close_array_type)
 << operator for closing a subarray in the core builder. More...
 
 operator array_context ()
 Conversion operator which provides a rooted array context given any stream currently in a nested array_context.
 

Additional Inherited Members

Detailed Description

A streaming interface for constructing a BSON array.

Note
Use of the stream builder is discouraged. See http://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/working-with-bson/#stream-builder for more details.

Member Function Documentation

◆ extract()

bsoncxx::array::value bsoncxx::builder::stream::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::stream::array::operator bsoncxx::array::view ( ) const
inline
Returns
A view of the BSON array.

◆ view()

bsoncxx::array::view bsoncxx::builder::stream::array::view ( ) const
inline
Returns
A view of the BSON array.

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