mutate_in_options.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2020-Present Couchbase, 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 <couchbase/subdoc/fwd/command_bundle.hxx>
 
#include <couchbase/codec/encoded_value.hxx>
#include <couchbase/common_durability_options.hxx>
#include <couchbase/error.hxx>
#include <couchbase/expiry.hxx>
#include <couchbase/mutate_in_result.hxx>
#include <couchbase/store_semantics.hxx>
 
#include <chrono>
#include <functional>
#include <memory>
#include <optional>
#include <vector>
 
namespace couchbase
{
 
struct mutate_in_options : public common_durability_options<mutate_in_options> {
  struct built : public common_durability_options<mutate_in_options>::built {
    const std::uint32_t expiry;
    const bool preserve_expiry;
    const couchbase::store_semantics store_semantics;
    const couchbase::cas cas;
    const bool access_deleted;
    const bool create_as_deleted;
  };
 
  [[nodiscard]] auto build() const -> built
  {
    auto base = build_common_durability_options();
    return { base, expiry_,         preserve_expiry_,  store_semantics_,
             cas_, access_deleted_, create_as_deleted_ };
  }
 
  auto preserve_expiry(bool preserve) -> mutate_in_options&
  {
    preserve_expiry_ = preserve;
    return self();
  }
 
  auto expiry(std::chrono::seconds duration) -> mutate_in_options&
  {
    expiry_ = core::impl::expiry_relative(duration);
    return self();
  }
 
  auto expiry(std::chrono::system_clock::time_point time_point) -> mutate_in_options&
  {
    expiry_ = core::impl::expiry_absolute(time_point);
    return self();
  }
 
  auto cas(couchbase::cas cas) -> mutate_in_options&
  {
    cas_ = cas;
    return self();
  }
  auto store_semantics(couchbase::store_semantics semantics) -> mutate_in_options&
  {
    store_semantics_ = semantics;
    return self();
  }
 
  auto access_deleted(bool value) -> mutate_in_options&
  {
    access_deleted_ = value;
    return self();
  }
 
  auto create_as_deleted(bool value) -> mutate_in_options&
  {
    create_as_deleted_ = value;
    return self();
  }
 
private:
  couchbase::store_semantics store_semantics_{ couchbase::store_semantics::replace };
  couchbase::cas cas_{};
  std::uint32_t expiry_{ 0 };
  bool preserve_expiry_{ false };
  bool access_deleted_{ false };
  bool create_as_deleted_{ false };
};
 
using mutate_in_handler = std::function<void(error, mutate_in_result)>;
} // namespace couchbase