binary_collection.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/append_options.hxx>
#include <couchbase/decrement_options.hxx>
#include <couchbase/error.hxx>
#include <couchbase/increment_options.hxx>
#include <couchbase/prepend_options.hxx>
 
#include <future>
#include <memory>
 
namespace couchbase
{
class collection;
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
namespace core
{
class cluster;
} // namespace core
class binary_collection_impl;
#endif
 
class binary_collection
{
public:
  [[nodiscard]] auto bucket_name() const -> const std::string&;
 
  [[nodiscard]] auto scope_name() const -> const std::string&;
 
  [[nodiscard]] auto name() const -> const std::string&;
 
  void append(std::string document_id,
              std::vector<std::byte> data,
              const append_options& options,
              append_handler&& handler) const;
 
  [[nodiscard]] auto append(std::string document_id,
                            std::vector<std::byte> data,
                            const append_options& options) const
    -> std::future<std::pair<error, mutation_result>>;
 
  void prepend(std::string document_id,
               std::vector<std::byte> data,
               const prepend_options& options,
               prepend_handler&& handler) const;
 
  [[nodiscard]] auto prepend(std::string document_id,
                             std::vector<std::byte> data,
                             const prepend_options& options) const
    -> std::future<std::pair<error, mutation_result>>;
 
  void increment(std::string document_id,
                 const increment_options& options,
                 increment_handler&& handler) const;
 
  [[nodiscard]] auto increment(std::string document_id, const increment_options& options) const
    -> std::future<std::pair<error, counter_result>>;
 
  void decrement(std::string document_id,
                 const decrement_options& options,
                 decrement_handler&& handler) const;
 
  [[nodiscard]] auto decrement(std::string document_id, const decrement_options& options) const
    -> std::future<std::pair<error, counter_result>>;
 
private:
  friend class collection;
 
  binary_collection(core::cluster core,
                    std::string_view bucket_name,
                    std::string_view scope_name,
                    std::string_view name);
 
  std::shared_ptr<binary_collection_impl> impl_;
};
} // namespace couchbase