MongoDB C++ Driver  mongocxx-3.7.0
insert_one.hpp
1 // Copyright 2014 MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <bsoncxx/array/value.hpp>
18 #include <bsoncxx/types.hpp>
19 #include <bsoncxx/types/bson_value/view.hpp>
20 #include <mongocxx/result/bulk_write.hpp>
21 
22 #include <mongocxx/config/prelude.hpp>
23 
24 namespace mongocxx {
25 MONGOCXX_INLINE_NAMESPACE_BEGIN
26 namespace result {
27 
29 class MONGOCXX_API insert_one {
30  public:
31  // This constructor is public for testing purposes only
33 
39  const result::bulk_write& result() const;
40 
46  const bsoncxx::types::bson_value::view& inserted_id() const;
47 
48  private:
49  result::bulk_write _result;
50 
51  // Array with a single element, containing the value of the _id field for the inserted document.
52  bsoncxx::array::value _inserted_id_owned;
53 
54  // Points into _inserted_id_owned.
56 
57  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const insert_one&, const insert_one&);
58  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const insert_one&, const insert_one&);
59 };
60 
61 } // namespace result
62 MONGOCXX_INLINE_NAMESPACE_END
63 } // namespace mongocxx
64 
65 #include <mongocxx/config/postlude.hpp>
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
mongocxx::result::bulk_write
Class representing the result of a MongoDB bulk write operation.
Definition: bulk_write.hpp:34
mongocxx::result::insert_one
Class representing the result of a MongoDB insert operation.
Definition: insert_one.hpp:29
bsoncxx::array::value
A read-only BSON array that owns its underlying buffer.
Definition: value.hpp:34
bsoncxx::types::bson_value::view
A view-only variant that can contain any BSON type.
Definition: view.hpp:44