update_one.hpp

// Copyright 2014 MongoDB Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <bsoncxx/array/view_or_value.hpp>
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <mongocxx/hint.hpp>
#include <mongocxx/pipeline.hpp>
#include <mongocxx/stdx.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
MONGOCXX_INLINE_NAMESPACE_BEGIN
 
namespace model {
 
class MONGOCXX_API update_one {
    //
    // Utility class supporting the convenience of {} meaning an empty bsoncxx::document.
    //
    // Users may not use this class directly.
    //
    // In places where driver methods take this class as a parameter, passing {} will
    // translate to a default-constructed bsoncxx::document::view_or_value,
    // regardless of other overloads taking other default-constructible types
    // for that parameter. This class avoids compiler ambiguity with such overloads.
    //
    // See update_one() for an example of such overloads.
    //
    class _empty_doc_tag {
        _empty_doc_tag() = default;
    };
 
   public:
    update_one(bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value update);
 
    update_one(bsoncxx::document::view_or_value filter, const pipeline& update);
 
    update_one(bsoncxx::document::view_or_value filter,
               std::initializer_list<_empty_doc_tag> update);
 
 
    const bsoncxx::document::view_or_value& filter() const;
 
    const bsoncxx::document::view_or_value& update() const;
 
    update_one& collation(bsoncxx::document::view_or_value collation);
 
    const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
 
    update_one& hint(class hint index_hint);
 
    const stdx::optional<class hint>& hint() const;
 
    update_one& upsert(bool upsert);
 
    const stdx::optional<bool>& upsert() const;
 
    update_one& array_filters(bsoncxx::array::view_or_value array_filters);
 
    const stdx::optional<bsoncxx::array::view_or_value>& array_filters() const;
 
   private:
    bsoncxx::document::view_or_value _filter;
    bsoncxx::document::view_or_value _update;
 
    stdx::optional<bsoncxx::document::view_or_value> _collation;
    stdx::optional<bsoncxx::array::view_or_value> _array_filters;
    stdx::optional<bool> _upsert;
    stdx::optional<class hint> _hint;
};
 
}  // namespace model
MONGOCXX_INLINE_NAMESPACE_END
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>