/* -*- 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/codec/encoded_value.hxx>
#include <couchbase/common_durability_options.hxx>
#include <couchbase/error.hxx>
#include <couchbase/expiry.hxx>
#include <couchbase/mutation_result.hxx>

#include <chrono>
#include <functional>
#include <memory>
#include <optional>
#include <vector>

namespace couchbase
{

/**
 * Options for @ref collection#remove().
 *
 * @since 1.0.0
 * @committed
 */
struct remove_options : public common_durability_options<remove_options> {
  /**
   * Immutable value object representing consistent options.
   *
   * @since 1.0.0
   * @internal
   */
  struct built : public common_durability_options<remove_options>::built {
    const couchbase::cas cas;
  };

  /**
   * Validates options and returns them as an immutable value.
   *
   * @return consistent options as an immutable value
   *
   * @exception std::system_error with code errc::common::invalid_argument if the options are not
   * valid
   *
   * @since 1.0.0
   * @internal
   */
  [[nodiscard]] auto build() const -> built
  {
    auto base = build_common_durability_options();
    return { base, cas_ };
  }

  /**
   * Specifies a CAS value that will be taken into account on the server side for optimistic
   * concurrency.
   *
   * The CAS value is an opaque identifier which is associated with a specific state of the document
   * on the server. The CAS value is received on read operations (or after mutations) and can be
   * used during a subsequent mutation to make sure that the document has not been modified in the
   * meantime.
   *
   * If document on the server has been modified in the meantime the SDK will raise a {@link
   * errc::common::cas_mismatch}. In this case the caller is expected to re-do the whole
   * "fetch-modify-update" cycle again. Please refer to the SDK documentation for more information
   * on CAS mismatches and subsequent retries.
   *
   * @param cas the opaque CAS identifier to use for this operation.
   * @return the {@link remove_options} for chaining purposes.
   */
  auto cas(couchbase::cas cas) -> remove_options&
  {

    cas_ = cas;
    return self();
  }

private:
  couchbase::cas cas_{};
};

/**
 * The signature for the handler of the @ref collection#remove() operation
 *
 * @since 1.0.0
 * @uncommitted
 */
using remove_handler = std::function<void(error, mutation_result)>;
} // namespace couchbase
