MongoDB C++ Driver  mongocxx-3.6.2
delete.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 <cstdint>
18 
19 #include <mongocxx/result/bulk_write.hpp>
20 
21 #include <mongocxx/config/prelude.hpp>
22 
23 namespace mongocxx {
24 MONGOCXX_INLINE_NAMESPACE_BEGIN
25 namespace result {
26 
30 class MONGOCXX_API delete_result {
31  public:
32  // This constructor is public for testing purposes only
33  explicit delete_result(result::bulk_write result);
34 
40  const result::bulk_write& result() const;
41 
47  std::int32_t deleted_count() const;
48 
49  private:
50  result::bulk_write _result;
51 
52  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const delete_result&, const delete_result&);
53  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const delete_result&, const delete_result&);
54 };
55 
56 } // namespace result
57 MONGOCXX_INLINE_NAMESPACE_END
58 } // namespace mongocxx
59 
60 #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::delete_result::result
const result::bulk_write & result() const
Returns the bulk write result.
mongocxx::result::delete_result::deleted_count
std::int32_t deleted_count() const
Gets the number of documents that were deleted during this operation.
mongocxx::result::delete_result
Class representing the result of a MongoDB delete operation.
Definition: delete.hpp:30