couchbase 3.5.1 → 3.5.2

data/ext/couchbase/couchbase/binary_collection.hxx

@@ -19,6 +19,7 @@
 
 #include <couchbase/append_options.hxx>
 #include <couchbase/decrement_options.hxx>
+#include <couchbase/error.hxx>
 #include <couchbase/increment_options.hxx>
 #include <couchbase/prepend_options.hxx>
 
@@ -44,188 +45,217 @@ class binary_collection_impl;
  */
 class binary_collection
 {
-  public:
-    /**
-     * Returns name of the bucket where the collection is defined.
-     *
-     * @return name of the bucket
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto bucket_name() const -> const std::string&;
-
-    /**
-     * Returns name of the scope where the collection is defined.
-     *
-     * @return name of the scope
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto scope_name() const -> const std::string&;
-
-    /**
-     * Returns name of the collection.
-     *
-     * @return name of the collection
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto name() const -> const std::string&;
-
-    /**
-     * Appends binary content to the document.
-     *
-     * @param document_id the document id which is used to uniquely identify it.
-     * @param data the document content to append.
-     * @param options custom options to customize the append behavior.
-     * @param handler callable that implements @ref append_handler
-     *
-     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
-     * @exception errc::common::cas_mismatch if the document has been concurrently modified on the server.
-     * @exception errc::common::ambiguous_timeout
-     * @exception errc::common::unambiguous_timeout
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void append(std::string document_id, std::vector<std::byte> data, const append_options& options, append_handler&& handler) const;
-
-    /**
-     * Appends binary content to the document.
-     *
-     * @param document_id the document id which is used to uniquely identify it.
-     * @param data the document content to append.
-     * @param options custom options to customize the append behavior.
-     * @return future object that carries result of the operation
-     *
-     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
-     * @exception errc::common::cas_mismatch if the document has been concurrently modified on the server.
-     * @exception errc::common::ambiguous_timeout
-     * @exception errc::common::unambiguous_timeout
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto append(std::string document_id, std::vector<std::byte> data, const append_options& options) const
-      -> std::future<std::pair<key_value_error_context, mutation_result>>;
-
-    /**
-     * Prepends binary content to the document.
-     *
-     * @tparam Handler type of the handler that implements @ref prepend_handler
-     *
-     * @param document_id the document id which is used to uniquely identify it.
-     * @param data the document content to prepend.
-     * @param options custom options to customize the prepend behavior.
-     * @param handler callable that implements @ref prepend_handler
-     *
-     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
-     * @exception errc::common::cas_mismatch if the document has been concurrently modified on the server.
-     * @exception errc::common::ambiguous_timeout
-     * @exception errc::common::unambiguous_timeout
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void prepend(std::string document_id, std::vector<std::byte> data, const prepend_options& options, prepend_handler&& handler) const;
-
-    /**
-     * Prepends binary content to the document.
-     *
-     * @param document_id the document id which is used to uniquely identify it.
-     * @param data the document content to prepend.
-     * @param options custom options to customize the prepend behavior.
-     * @return future object that carries result of the operation
-     *
-     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
-     * @exception errc::common::cas_mismatch if the document has been concurrently modified on the server.
-     * @exception errc::common::ambiguous_timeout
-     * @exception errc::common::unambiguous_timeout
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto prepend(std::string document_id, std::vector<std::byte> data, const prepend_options& options) const
-      -> std::future<std::pair<key_value_error_context, mutation_result>>;
-
-    /**
-     * Increments the counter document by one or the number defined in the options.
-     *
-     * @tparam Handler type of the handler that implements @ref increment_handler
-     *
-     * @param document_id the document id which is used to uniquely identify it.
-     * @param options custom options to customize the increment behavior.
-     * @param handler callable that implements @ref increment_handler
-     *
-     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
-     * @exception errc::common::ambiguous_timeout
-     * @exception errc::common::unambiguous_timeout
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void increment(std::string document_id, const increment_options& options, increment_handler&& handler) const;
-
-    /**
-     * Increments the counter document by one or the number defined in the options.
-     *
-     * @param document_id the document id which is used to uniquely identify it.
-     * @param options custom options to customize the increment behavior.
-     * @return future object that carries result of the operation
-     *
-     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
-     * @exception errc::common::ambiguous_timeout
-     * @exception errc::common::unambiguous_timeout
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto increment(std::string document_id, const increment_options& options) const
-      -> std::future<std::pair<key_value_error_context, counter_result>>;
-
-    /**
-     * Decrements the counter document by one or the number defined in the options.
-     *
-     * @tparam Handler type of the handler that implements @ref decrement_handler
-     *
-     * @param document_id the document id which is used to uniquely identify it.
-     * @param options custom options to customize the decrement behavior.
-     * @param handler callable that implements @ref decrement_handler
-     *
-     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
-     * @exception errc::common::ambiguous_timeout
-     * @exception errc::common::unambiguous_timeout
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void decrement(std::string document_id, const decrement_options& options, decrement_handler&& handler) const;
-
-    /**
-     * Decrements the counter document by one or the number defined in the options.
-     *
-     * @param document_id the document id which is used to uniquely identify it.
-     * @param options custom options to customize the decrement behavior.
-     * @return future object that carries result of the operation
-     *
-     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
-     * @exception errc::common::ambiguous_timeout
-     * @exception errc::common::unambiguous_timeout
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto decrement(std::string document_id, const decrement_options& options) const
-      -> std::future<std::pair<key_value_error_context, 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_;
+public:
+  /**
+   * Returns name of the bucket where the collection is defined.
+   *
+   * @return name of the bucket
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto bucket_name() const -> const std::string&;
+
+  /**
+   * Returns name of the scope where the collection is defined.
+   *
+   * @return name of the scope
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto scope_name() const -> const std::string&;
+
+  /**
+   * Returns name of the collection.
+   *
+   * @return name of the collection
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto name() const -> const std::string&;
+
+  /**
+   * Appends binary content to the document.
+   *
+   * @param document_id the document id which is used to uniquely identify it.
+   * @param data the document content to append.
+   * @param options custom options to customize the append behavior.
+   * @param handler callable that implements @ref append_handler
+   *
+   * @exception errc::key_value::document_not_found the given document id is not found in the
+   * collection.
+   * @exception errc::common::cas_mismatch if the document has been concurrently modified on the
+   * server.
+   * @exception errc::common::ambiguous_timeout
+   * @exception errc::common::unambiguous_timeout
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void append(std::string document_id,
+              std::vector<std::byte> data,
+              const append_options& options,
+              append_handler&& handler) const;
+
+  /**
+   * Appends binary content to the document.
+   *
+   * @param document_id the document id which is used to uniquely identify it.
+   * @param data the document content to append.
+   * @param options custom options to customize the append behavior.
+   * @return future object that carries result of the operation
+   *
+   * @exception errc::key_value::document_not_found the given document id is not found in the
+   * collection.
+   * @exception errc::common::cas_mismatch if the document has been concurrently modified on the
+   * server.
+   * @exception errc::common::ambiguous_timeout
+   * @exception errc::common::unambiguous_timeout
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto append(std::string document_id,
+                            std::vector<std::byte> data,
+                            const append_options& options) const
+    -> std::future<std::pair<error, mutation_result>>;
+
+  /**
+   * Prepends binary content to the document.
+   *
+   * @tparam Handler type of the handler that implements @ref prepend_handler
+   *
+   * @param document_id the document id which is used to uniquely identify it.
+   * @param data the document content to prepend.
+   * @param options custom options to customize the prepend behavior.
+   * @param handler callable that implements @ref prepend_handler
+   *
+   * @exception errc::key_value::document_not_found the given document id is not found in the
+   * collection.
+   * @exception errc::common::cas_mismatch if the document has been concurrently modified on the
+   * server.
+   * @exception errc::common::ambiguous_timeout
+   * @exception errc::common::unambiguous_timeout
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void prepend(std::string document_id,
+               std::vector<std::byte> data,
+               const prepend_options& options,
+               prepend_handler&& handler) const;
+
+  /**
+   * Prepends binary content to the document.
+   *
+   * @param document_id the document id which is used to uniquely identify it.
+   * @param data the document content to prepend.
+   * @param options custom options to customize the prepend behavior.
+   * @return future object that carries result of the operation
+   *
+   * @exception errc::key_value::document_not_found the given document id is not found in the
+   * collection.
+   * @exception errc::common::cas_mismatch if the document has been concurrently modified on the
+   * server.
+   * @exception errc::common::ambiguous_timeout
+   * @exception errc::common::unambiguous_timeout
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto prepend(std::string document_id,
+                             std::vector<std::byte> data,
+                             const prepend_options& options) const
+    -> std::future<std::pair<error, mutation_result>>;
+
+  /**
+   * Increments the counter document by one or the number defined in the options.
+   *
+   * @tparam Handler type of the handler that implements @ref increment_handler
+   *
+   * @param document_id the document id which is used to uniquely identify it.
+   * @param options custom options to customize the increment behavior.
+   * @param handler callable that implements @ref increment_handler
+   *
+   * @exception errc::key_value::document_not_found the given document id is not found in the
+   * collection.
+   * @exception errc::common::ambiguous_timeout
+   * @exception errc::common::unambiguous_timeout
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void increment(std::string document_id,
+                 const increment_options& options,
+                 increment_handler&& handler) const;
+
+  /**
+   * Increments the counter document by one or the number defined in the options.
+   *
+   * @param document_id the document id which is used to uniquely identify it.
+   * @param options custom options to customize the increment behavior.
+   * @return future object that carries result of the operation
+   *
+   * @exception errc::key_value::document_not_found the given document id is not found in the
+   * collection.
+   * @exception errc::common::ambiguous_timeout
+   * @exception errc::common::unambiguous_timeout
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto increment(std::string document_id, const increment_options& options) const
+    -> std::future<std::pair<error, counter_result>>;
+
+  /**
+   * Decrements the counter document by one or the number defined in the options.
+   *
+   * @tparam Handler type of the handler that implements @ref decrement_handler
+   *
+   * @param document_id the document id which is used to uniquely identify it.
+   * @param options custom options to customize the decrement behavior.
+   * @param handler callable that implements @ref decrement_handler
+   *
+   * @exception errc::key_value::document_not_found the given document id is not found in the
+   * collection.
+   * @exception errc::common::ambiguous_timeout
+   * @exception errc::common::unambiguous_timeout
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void decrement(std::string document_id,
+                 const decrement_options& options,
+                 decrement_handler&& handler) const;
+
+  /**
+   * Decrements the counter document by one or the number defined in the options.
+   *
+   * @param document_id the document id which is used to uniquely identify it.
+   * @param options custom options to customize the decrement behavior.
+   * @return future object that carries result of the operation
+   *
+   * @exception errc::key_value::document_not_found the given document id is not found in the
+   * collection.
+   * @exception errc::common::ambiguous_timeout
+   * @exception errc::common::unambiguous_timeout
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[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

data/ext/couchbase/couchbase/boolean_field_query.hxx

@@ -32,46 +32,46 @@ namespace couchbase
  */
 class boolean_field_query : public search_query
 {
-  public:
-    /**
-     * Create a new boolean field query.
-     *
-     * @param value the input string to be matched against
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    explicit boolean_field_query(bool value)
-      : bool_{ value }
-    {
-    }
+public:
+  /**
+   * Create a new boolean field query.
+   *
+   * @param value the input string to be matched against
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  explicit boolean_field_query(bool value)
+    : bool_{ value }
+  {
+  }
 
-    /**
-     * If a field is specified, only terms in that field will be matched.
-     *
-     * @param field_name name of the field to be matched
-     *
-     * @return this query for chaining purposes.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    auto field(std::string field_name) -> boolean_field_query&
-    {
-        field_ = std::move(field_name);
-        return *this;
-    }
+  /**
+   * If a field is specified, only terms in that field will be matched.
+   *
+   * @param field_name name of the field to be matched
+   *
+   * @return this query for chaining purposes.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  auto field(std::string field_name) -> boolean_field_query&
+  {
+    field_ = std::move(field_name);
+    return *this;
+  }
 
-    /**
-     * @return encoded representation of the query.
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    [[nodiscard]] auto encode() const -> encoded_search_query override;
+  /**
+   * @return encoded representation of the query.
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  [[nodiscard]] auto encode() const -> encoded_search_query override;
 
-  private:
-    bool bool_;
-    std::optional<std::string> field_{};
+private:
+  bool bool_;
+  std::optional<std::string> field_{};
 };
 } // namespace couchbase