couchbase 3.5.1 → 3.5.2

data/ext/couchbase/couchbase/get_options.hxx

@@ -18,8 +18,8 @@
 #pragma once
 
 #include <couchbase/common_options.hxx>
+#include <couchbase/error.hxx>
 #include <couchbase/get_result.hxx>
-#include <couchbase/key_value_error_context.hxx>
 
 #include <chrono>
 #include <functional>
@@ -35,68 +35,71 @@ namespace couchbase
  * @committed
  */
 struct get_options : public common_options<get_options> {
-    /**
-     * Immutable value object representing consistent options.
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    struct built : public common_options<get_options>::built {
-        const bool with_expiry;
-        const std::vector<std::string> projections;
-    };
+  /**
+   * Immutable value object representing consistent options.
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  struct built : public common_options<get_options>::built {
+    const bool with_expiry;
+    const std::vector<std::string> projections;
+  };
 
-    /**
-     * 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
-    {
-        return { build_common_options(), with_expiry_, projections_ };
-    }
+  /**
+   * 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
+  {
+    return { build_common_options(), with_expiry_, projections_ };
+  }
 
-    /**
-     * If set to true, the get will fetch the expiry for the document as well and return it as part of the {@link get_result}.
-     *
-     * @param return_expiry true if it should be fetched.
-     * @return this options builder for chaining purposes.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    auto with_expiry(bool return_expiry) -> get_options&
-    {
-        with_expiry_ = return_expiry;
-        return self();
-    }
+  /**
+   * If set to true, the get will fetch the expiry for the document as well and return it as part of
+   * the {@link get_result}.
+   *
+   * @param return_expiry true if it should be fetched.
+   * @return this options builder for chaining purposes.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  auto with_expiry(bool return_expiry) -> get_options&
+  {
+    with_expiry_ = return_expiry;
+    return self();
+  }
 
-    /**
-     * Allows to specify a custom list paths to fetch from the document instead of the whole.
-     *
-     * @note that a maximum of 16 individual paths can be projected at a time due to a server limitation. If you need more than that, think
-     * about fetching less-generic paths or the full document straight away.
-     *
-     * @param field_paths a list of paths that should be loaded if present.
-     * @return this options builder for chaining purposes.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    auto project(std::vector<std::string> field_paths) -> get_options&
-    {
-        projections_ = std::move(field_paths);
-        return self();
-    }
+  /**
+   * Allows to specify a custom list paths to fetch from the document instead of the whole.
+   *
+   * @note that a maximum of 16 individual paths can be projected at a time due to a server
+   * limitation. If you need more than that, think about fetching less-generic paths or the full
+   * document straight away.
+   *
+   * @param field_paths a list of paths that should be loaded if present.
+   * @return this options builder for chaining purposes.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  auto project(std::vector<std::string> field_paths) -> get_options&
+  {
+    projections_ = std::move(field_paths);
+    return self();
+  }
 
-  private:
-    bool with_expiry_{ false };
-    std::vector<std::string> projections_{};
+private:
+  bool with_expiry_{ false };
+  std::vector<std::string> projections_{};
 };
 
 /**
@@ -105,5 +108,5 @@ struct get_options : public common_options<get_options> {
  * @since 1.0.0
  * @uncommitted
  */
-using get_handler = std::function<void(couchbase::key_value_error_context, get_result)>;
+using get_handler = std::function<void(error, get_result)>;
 } // namespace couchbase

data/ext/couchbase/couchbase/get_pending_mutations_analytics_options.hxx

@@ -19,7 +19,6 @@
 
 #include <couchbase/common_options.hxx>
 #include <couchbase/error_codes.hxx>
-#include <couchbase/manager_error_context.hxx>
 
 #include <cstdint>
 #include <functional>
@@ -28,40 +27,43 @@
 
 namespace couchbase
 {
-class get_pending_mutations_analytics_options : public common_options<get_pending_mutations_analytics_options>
+class get_pending_mutations_analytics_options
+  : public common_options<get_pending_mutations_analytics_options>
 {
-  public:
-    /**
-     * Immutable value object representing consistent options.
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    struct built : public common_options<get_pending_mutations_analytics_options>::built {
-    };
+public:
+  /**
+   * Immutable value object representing consistent options.
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  struct built : public common_options<get_pending_mutations_analytics_options>::built {
+  };
 
-    /**
-     * 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
-    {
-        return { build_common_options() };
-    }
+  /**
+   * 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
+  {
+    return { build_common_options() };
+  }
 };
 
 /**
- * The signature for the handler of the @ref analytics_index_manager#get_pending_mutations() operation
+ * The signature for the handler of the @ref analytics_index_manager#get_pending_mutations()
+ * operation
  *
  * @since 1.0.0
  * @uncommitted
  */
 using get_pending_mutations_analytics_handler =
-  std::function<void(couchbase::manager_error_context, std::map<std::string, std::map<std::string, std::int64_t>>)>;
-} // namespace couchbase
+  std::function<void(error, std::map<std::string, std::map<std::string, std::int64_t>>)>;
+} // namespace couchbase

data/ext/couchbase/couchbase/get_replica_result.hxx

@@ -26,92 +26,96 @@ namespace couchbase
 {
 
 /**
- * Represents result of @ref collection#get_any_replica operations, also returned by @ref collection#get_all_replicas.
+ * Represents result of @ref collection#get_any_replica operations, also returned by @ref
+ * collection#get_all_replicas.
  *
  * @since 1.0.0
  * @committed
  */
 class get_replica_result : public result
 {
-  public:
-    /**
-     * @since 1.0.0
-     * @internal
-     */
-    get_replica_result() = default;
+public:
+  /**
+   * @since 1.0.0
+   * @internal
+   */
+  get_replica_result() = default;
 
-    /**
-     * Constructs result for get_any_replica operation, or an entry for get_all_replicas operation.
-     *
-     * @param cas
-     * @param is_replica true if the document originates from replica node
-     * @param value raw document contents along with flags describing its structure
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    get_replica_result(couchbase::cas cas, bool is_replica, codec::encoded_value value)
-      : result{ cas }
-      , is_replica_{ is_replica }
-      , value_{ std::move(value) }
-    {
-    }
+  /**
+   * Constructs result for get_any_replica operation, or an entry for get_all_replicas operation.
+   *
+   * @param cas
+   * @param is_replica true if the document originates from replica node
+   * @param value raw document contents along with flags describing its structure
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  get_replica_result(couchbase::cas cas, bool is_replica, codec::encoded_value value)
+    : result{ cas }
+    , is_replica_{ is_replica }
+    , value_{ std::move(value) }
+  {
+  }
 
-    /**
-     *
-     * @return true if the document came from replica, false for active node.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto is_replica() const -> bool
-    {
-        return is_replica_;
-    }
+  /**
+   *
+   * @return true if the document came from replica, false for active node.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto is_replica() const -> bool
+  {
+    return is_replica_;
+  }
 
-    /**
-     * Decodes content of the document using given transcoder.
-     *
-     * @tparam Transcoder type that has static function `decode` that takes codec::encoded_value and returns `Transcoder::document_type`
-     * @return decoded document content
-     *
-     * @par Get flags and value as they are stored in the result
-     *  Here is an example of custom transcoder, that just extracts value and flags as they are stored in the result.
-     * @snippet test_integration_read_replica.cxx smuggling-transcoder
-     *  Usage
-     * @snippet test_integration_read_replica.cxx smuggling-transcoder-usage
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    template<typename Transcoder, std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
-    [[nodiscard]] auto content_as() const -> typename Transcoder::document_type
-    {
-        return Transcoder::decode(value_);
-    }
+  /**
+   * Decodes content of the document using given transcoder.
+   *
+   * @tparam Transcoder type that has static function `decode` that takes codec::encoded_value and
+   * returns `Transcoder::document_type`
+   * @return decoded document content
+   *
+   * @par Get flags and value as they are stored in the result
+   *  Here is an example of custom transcoder, that just extracts value and flags as they are stored
+   * in the result.
+   * @snippet test_integration_read_replica.cxx smuggling-transcoder
+   *  Usage
+   * @snippet test_integration_read_replica.cxx smuggling-transcoder-usage
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  template<typename Transcoder, std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
+  [[nodiscard]] auto content_as() const -> typename Transcoder::document_type
+  {
+    return Transcoder::decode(value_);
+  }
 
-    /**
-     * Decodes content of the document using given codec.
-     *
-     * @tparam Document custom type that `Transcoder` returns
-     * @tparam Transcoder type that has static function `decode` that takes codec::encoded_value and returns `Document`
-     * @return decoded document content
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    template<typename Document,
-             typename Transcoder = codec::default_json_transcoder,
-             std::enable_if_t<!codec::is_transcoder_v<Document>, bool> = true,
-             std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
-    [[nodiscard]] auto content_as() const -> Document
-    {
-        return Transcoder::template decode<Document>(value_);
-    }
+  /**
+   * Decodes content of the document using given codec.
+   *
+   * @tparam Document custom type that `Transcoder` returns
+   * @tparam Transcoder type that has static function `decode` that takes codec::encoded_value and
+   * returns `Document`
+   * @return decoded document content
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  template<typename Document,
+           typename Transcoder = codec::default_json_transcoder,
+           std::enable_if_t<!codec::is_transcoder_v<Document>, bool> = true,
+           std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
+  [[nodiscard]] auto content_as() const -> Document
+  {
+    return Transcoder::template decode<Document>(value_);
+  }
 
-  private:
-    bool is_replica_{ false };
-    codec::encoded_value value_{};
+private:
+  bool is_replica_{ false };
+  codec::encoded_value value_{};
 };
 
 } // namespace couchbase

data/ext/couchbase/couchbase/get_result.hxx

@@ -36,91 +36,97 @@ namespace couchbase
  */
 class get_result : public result
 {
-  public:
-    /**
-     * @since 1.0.0
-     * @internal
-     */
-    get_result() = default;
+public:
+  /**
+   * @since 1.0.0
+   * @internal
+   */
+  get_result() = default;
 
-    /**
-     * Constructs result for get operation
-     *
-     * @param cas
-     * @param value raw document contents along with flags describing its structure
-     * @param expiry_time optional point in time when the document will expire
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    get_result(couchbase::cas cas, codec::encoded_value value, std::optional<std::chrono::system_clock::time_point> expiry_time)
-      : result{ cas }
-      , value_{ std::move(value) }
-      , expiry_time_{ expiry_time }
-    {
-    }
+  /**
+   * Constructs result for get operation
+   *
+   * @param cas
+   * @param value raw document contents along with flags describing its structure
+   * @param expiry_time optional point in time when the document will expire
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  get_result(couchbase::cas cas,
+             codec::encoded_value value,
+             std::optional<std::chrono::system_clock::time_point> expiry_time)
+    : result{ cas }
+    , value_{ std::move(value) }
+    , expiry_time_{ expiry_time }
+  {
+  }
 
-    /**
-     * Decodes content of the document using given codec.
-     *
-     * @tparam Document custom type that `Transcoder` returns
-     * @tparam Transcoder type that has static function `decode` that takes codec::encoded_value and returns `Document`
-     * @return decoded document content
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    template<typename Document,
-             typename Transcoder = codec::default_json_transcoder,
-             std::enable_if_t<!codec::is_transcoder_v<Document>, bool> = true,
-             std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
-    [[nodiscard]] auto content_as() const -> Document
-    {
-        return Transcoder::template decode<Document>(value_);
-    }
+  /**
+   * Decodes content of the document using given codec.
+   *
+   * @tparam Document custom type that `Transcoder` returns
+   * @tparam Transcoder type that has static function `decode` that takes codec::encoded_value and
+   * returns `Document`
+   * @return decoded document content
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  template<typename Document,
+           typename Transcoder = codec::default_json_transcoder,
+           std::enable_if_t<!codec::is_transcoder_v<Document>, bool> = true,
+           std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
+  [[nodiscard]] auto content_as() const -> Document
+  {
+    return Transcoder::template decode<Document>(value_);
+  }
 
-    /**
-     * Decodes content of the document using given codec.
-     *
-     * @tparam Transcoder type that has static function `decode` that takes codec::encoded_value and returns `Transcoder::value_type`
-     * @return decoded document content
-     *
-     * @par Get flags and value as they are stored in the result
-     *  Here is an example of custom transcoder, that just extracts value and flags as they are stored in the result.
-     * @snippet test_integration_read_replica.cxx smuggling-transcoder
-     *  Usage
-     * @snippet test_integration_read_replica.cxx smuggling-transcoder-usage
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    template<typename Transcoder, std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
-    [[nodiscard]] auto content_as() const -> typename Transcoder::document_type
-    {
-        return Transcoder::decode(value_);
-    }
+  /**
+   * Decodes content of the document using given codec.
+   *
+   * @tparam Transcoder type that has static function `decode` that takes codec::encoded_value and
+   * returns `Transcoder::value_type`
+   * @return decoded document content
+   *
+   * @par Get flags and value as they are stored in the result
+   *  Here is an example of custom transcoder, that just extracts value and flags as they are stored
+   * in the result.
+   * @snippet test_integration_read_replica.cxx smuggling-transcoder
+   *  Usage
+   * @snippet test_integration_read_replica.cxx smuggling-transcoder-usage
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  template<typename Transcoder, std::enable_if_t<codec::is_transcoder_v<Transcoder>, bool> = true>
+  [[nodiscard]] auto content_as() const -> typename Transcoder::document_type
+  {
+    return Transcoder::decode(value_);
+  }
 
-    /**
-     * If the document has an expiry, returns the point in time when the loaded
-     * document expires.
-     *
-     * @note This method always returns an empty `std::optional` unless
-     * the {@link collection#get()} request was made using {@link get_options#with_expiry()}
-     * set to true.
-     *
-     * @return expiry time if present
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto expiry_time() const -> const std::optional<std::chrono::system_clock::time_point>&
-    {
-        return expiry_time_;
-    }
+  /**
+   * If the document has an expiry, returns the point in time when the loaded
+   * document expires.
+   *
+   * @note This method always returns an empty `std::optional` unless
+   * the {@link collection#get()} request was made using {@link get_options#with_expiry()}
+   * set to true.
+   *
+   * @return expiry time if present
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto expiry_time() const
+    -> const std::optional<std::chrono::system_clock::time_point>&
+  {
+    return expiry_time_;
+  }
 
-  private:
-    codec::encoded_value value_{};
-    std::optional<std::chrono::system_clock::time_point> expiry_time_{};
+private:
+  codec::encoded_value value_{};
+  std::optional<std::chrono::system_clock::time_point> expiry_time_{};
 };
 
 } // namespace couchbase

data/ext/couchbase/couchbase/get_search_index_options.hxx

@@ -28,17 +28,17 @@
 namespace couchbase
 {
 struct get_search_index_options : public common_options<get_search_index_options> {
-  public:
-    struct built : public common_options<get_search_index_options>::built {
-    };
+public:
+  struct built : public common_options<get_search_index_options>::built {
+  };
 
-    [[nodiscard]] auto build() const -> built
-    {
-        return { build_common_options() };
-    }
+  [[nodiscard]] auto build() const -> built
+  {
+    return { build_common_options() };
+  }
 
-  private:
+private:
 };
 
-using get_search_index_handler = std::function<void(couchbase::manager_error_context, couchbase::management::search::index)>;
+using get_search_index_handler = std::function<void(error, management::search::index)>;
 } // namespace couchbase

data/ext/couchbase/couchbase/highlight_style.hxx

@@ -26,20 +26,20 @@ namespace couchbase
  * @committed
  */
 enum class highlight_style {
-    /**
-     * Use HTML tags `<mark>` and `</mark>` to indicate matches in the fields.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    html,
+  /**
+   * Use HTML tags `<mark>` and `</mark>` to indicate matches in the fields.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  html,
 
-    /**
-     * Use ANSI code sequences `\\x1b[43m>` and `\\x1b[0m` to indicate matches in the fields.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    ansi,
+  /**
+   * Use ANSI code sequences `\\x1b[43m>` and `\\x1b[0m` to indicate matches in the fields.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  ansi,
 };
 } // namespace couchbase