couchbase 3.5.1 → 3.5.2

data/ext/couchbase/couchbase/retry_reason.hxx

@@ -26,77 +26,79 @@ namespace couchbase
  * @committed
  */
 enum class retry_reason {
-    /**
-     * default value, e.g. when we don't need to retry
-     */
-    do_not_retry,
+  /**
+   * default value, e.g. when we don't need to retry
+   */
+  do_not_retry,
 
-    /**
-     * All unexpected/unknown retry errors must not be retried to avoid accidental data loss and non-deterministic behavior.
-     */
-    unknown,
+  /**
+   * All unexpected/unknown retry errors must not be retried to avoid accidental data loss and
+   * non-deterministic behavior.
+   */
+  unknown,
 
-    /**
-     * The socket is not available into which the operation should’ve been written.
-     */
-    socket_not_available,
+  /**
+   * The socket is not available into which the operation should’ve been written.
+   */
+  socket_not_available,
 
-    /**
-     * The service on a node (i.e. key_value, query) is not available.
-     */
-    service_not_available,
+  /**
+   * The service on a node (i.e. key_value, query) is not available.
+   */
+  service_not_available,
 
-    /**
-     * The node where the operation is supposed to be dispatched to is not available.
-     */
-    node_not_available,
+  /**
+   * The node where the operation is supposed to be dispatched to is not available.
+   */
+  node_not_available,
 
-    /**
-     * A not my vbucket response has been received.
-     */
-    key_value_not_my_vbucket,
+  /**
+   * A not my vbucket response has been received.
+   */
+  key_value_not_my_vbucket,
 
-    /**
-     * A KV response has been received which signals an outdated collection.
-     */
-    key_value_collection_outdated,
+  /**
+   * A KV response has been received which signals an outdated collection.
+   */
+  key_value_collection_outdated,
 
-    /**
-     * An unknown response was returned and the consulted KV error map indicated a retry.
-     */
-    key_value_error_map_retry_indicated,
+  /**
+   * An unknown response was returned and the consulted KV error map indicated a retry.
+   */
+  key_value_error_map_retry_indicated,
 
-    key_value_locked,
+  key_value_locked,
 
-    key_value_temporary_failure,
+  key_value_temporary_failure,
 
-    key_value_sync_write_in_progress,
+  key_value_sync_write_in_progress,
 
-    key_value_sync_write_re_commit_in_progress,
+  key_value_sync_write_re_commit_in_progress,
 
-    service_response_code_indicated,
+  service_response_code_indicated,
 
-    /**
-     * While an operation was in-flight, the underlying socket has been closed.
-     */
-    socket_closed_while_in_flight,
+  /**
+   * While an operation was in-flight, the underlying socket has been closed.
+   */
+  socket_closed_while_in_flight,
 
-    /**
-     * The circuit breaker is open for the given socket/endpoint and as a result the operation is not sent into it.
-     */
-    circuit_breaker_open,
+  /**
+   * The circuit breaker is open for the given socket/endpoint and as a result the operation is not
+   * sent into it.
+   */
+  circuit_breaker_open,
 
-    query_prepared_statement_failure,
+  query_prepared_statement_failure,
 
-    query_index_not_found,
+  query_index_not_found,
 
-    analytics_temporary_failure,
+  analytics_temporary_failure,
 
-    search_too_many_requests,
+  search_too_many_requests,
 
-    views_temporary_failure,
+  views_temporary_failure,
 
-    views_no_active_partition,
+  views_no_active_partition,
 };
 
 bool

data/ext/couchbase/couchbase/retry_request.hxx

@@ -26,14 +26,14 @@ namespace couchbase
 {
 class retry_request
 {
-  public:
-    [[nodiscard]] virtual auto retry_attempts() const -> std::size_t = 0;
-    [[nodiscard]] virtual auto identifier() const -> std::string = 0;
-    [[nodiscard]] virtual auto idempotent() const -> bool = 0;
-    [[nodiscard]] virtual auto retry_reasons() const -> std::set<retry_reason> = 0;
+public:
+  [[nodiscard]] virtual auto retry_attempts() const -> std::size_t = 0;
+  [[nodiscard]] virtual auto identifier() const -> std::string = 0;
+  [[nodiscard]] virtual auto idempotent() const -> bool = 0;
+  [[nodiscard]] virtual auto retry_reasons() const -> std::set<retry_reason> = 0;
 
-    virtual ~retry_request() = default;
+  virtual ~retry_request() = default;
 
-    virtual void record_retry_attempt(retry_reason reason) = 0;
+  virtual void record_retry_attempt(retry_reason reason) = 0;
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/retry_strategy.hxx

@@ -27,9 +27,9 @@ namespace couchbase
 {
 class retry_strategy
 {
-  public:
-    virtual ~retry_strategy() = default;
-    virtual auto retry_after(const retry_request& request, retry_reason reason) -> retry_action = 0;
-    [[nodiscard]] virtual auto to_string() const -> std::string = 0;
+public:
+  virtual ~retry_strategy() = default;
+  virtual auto retry_after(const retry_request& request, retry_reason reason) -> retry_action = 0;
+  [[nodiscard]] virtual auto to_string() const -> std::string = 0;
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/scan_options.hxx

@@ -18,6 +18,7 @@
 #pragma once
 
 #include <couchbase/common_options.hxx>
+#include <couchbase/error.hxx>
 #include <couchbase/mutation_state.hxx>
 #include <couchbase/mutation_token.hxx>
 #include <couchbase/scan_result.hxx>
@@ -37,120 +38,125 @@ namespace couchbase
  * @committed
  */
 struct scan_options : public common_options<scan_options> {
-  public:
-    /**
-     * Specifies whether only document IDs should be included in the results. Defaults to false.
-     *
-     * @param ids_only if set to true the content will not be included in the results
-     * @return the options builder for chaining purposes.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    auto ids_only(bool ids_only) -> scan_options&
-    {
-        ids_only_ = ids_only;
-        return self();
-    }
+public:
+  /**
+   * Specifies whether only document IDs should be included in the results. Defaults to false.
+   *
+   * @param ids_only if set to true the content will not be included in the results
+   * @return the options builder for chaining purposes.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  auto ids_only(bool ids_only) -> scan_options&
+  {
+    ids_only_ = ids_only;
+    return self();
+  }
 
-    /**
-     * Sets the {@link mutation_token}s this scan should be consistent with.
-     *
-     * These mutation tokens are returned from mutations (i.e. as part of a {@link mutation_result}) and if you want your
-     * scan to include those you need to pass the mutation tokens into a {@link mutation_state}.
-     *
-     * @param state the mutation state containing the mutation tokens.
-     * @return the options builder for chaining purposes.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    auto consistent_with(const mutation_state& state) -> scan_options&
-    {
-        mutation_state_ = state.tokens();
-        return self();
-    }
+  /**
+   * Sets the {@link mutation_token}s this scan should be consistent with.
+   *
+   * These mutation tokens are returned from mutations (i.e. as part of a {@link mutation_result})
+   * and if you want your scan to include those you need to pass the mutation tokens into a {@link
+   * mutation_state}.
+   *
+   * @param state the mutation state containing the mutation tokens.
+   * @return the options builder for chaining purposes.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  auto consistent_with(const mutation_state& state) -> scan_options&
+  {
+    mutation_state_ = state.tokens();
+    return self();
+  }
 
-    /**
-     * Allows to limit the maximum amount of bytes that are sent from the server in each partition batch. Defaults to 15,000.
-     *
-     * @param batch_byte_limit the byte limit
-     * @return the options builder for chaining purposes.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    auto batch_byte_limit(std::uint32_t batch_byte_limit) -> scan_options&
-    {
-        batch_byte_limit_ = batch_byte_limit;
-        return self();
-    }
+  /**
+   * Allows to limit the maximum amount of bytes that are sent from the server in each partition
+   * batch. Defaults to 15,000.
+   *
+   * @param batch_byte_limit the byte limit
+   * @return the options builder for chaining purposes.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  auto batch_byte_limit(std::uint32_t batch_byte_limit) -> scan_options&
+  {
+    batch_byte_limit_ = batch_byte_limit;
+    return self();
+  }
 
-    /**
-     * Allows to limit the maximum number of scan items that are sent from the server in each partition batch. Defaults to 50.
-     *
-     * @param batch_item_limit the item limit
-     * @return the options builder for chaining purposes.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    auto batch_item_limit(std::uint32_t batch_item_limit) -> scan_options&
-    {
-        batch_item_limit_ = batch_item_limit;
-        return self();
-    }
+  /**
+   * Allows to limit the maximum number of scan items that are sent from the server in each
+   * partition batch. Defaults to 50.
+   *
+   * @param batch_item_limit the item limit
+   * @return the options builder for chaining purposes.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  auto batch_item_limit(std::uint32_t batch_item_limit) -> scan_options&
+  {
+    batch_item_limit_ = batch_item_limit;
+    return self();
+  }
 
-    /**
-     * Specifies the maximum number of partitions that can be scanned concurrently. Defaults to 1.
-     *
-     * @param concurrency the maximum number of concurrent partition scans
-     * @return the options builder for chaining purposes.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    auto concurrency(std::uint16_t concurrency) -> scan_options&
-    {
-        concurrency_ = concurrency;
-        return self();
-    }
+  /**
+   * Specifies the maximum number of partitions that can be scanned concurrently. Defaults to 1.
+   *
+   * @param concurrency the maximum number of concurrent partition scans
+   * @return the options builder for chaining purposes.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  auto concurrency(std::uint16_t concurrency) -> scan_options&
+  {
+    concurrency_ = concurrency;
+    return self();
+  }
 
-    /**
-     * Immutable value object representing consistent options.
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    struct built : public common_options<scan_options>::built {
-        bool ids_only;
-        std::vector<mutation_token> mutation_state;
-        std::optional<std::uint32_t> batch_byte_limit;
-        std::optional<std::uint32_t> batch_item_limit;
-        std::optional<std::uint16_t> concurrency;
-    };
+  /**
+   * Immutable value object representing consistent options.
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  struct built : public common_options<scan_options>::built {
+    bool ids_only;
+    std::vector<mutation_token> mutation_state;
+    std::optional<std::uint32_t> batch_byte_limit;
+    std::optional<std::uint32_t> batch_item_limit;
+    std::optional<std::uint16_t> concurrency;
+  };
 
-    /**
-     * Validates options and returns them as an immutable value.
-     *
-     * @return consistent options as an immutable value.
-     *
-     * @exception std::system_error with code @ref errc::common::invalid_argument if the options are not valid.
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    [[nodiscard]] auto build() const -> built
-    {
-        return { build_common_options(), ids_only_, mutation_state_, batch_byte_limit_, batch_item_limit_, concurrency_ };
-    }
+  /**
+   * Validates options and returns them as an immutable value.
+   *
+   * @return consistent options as an immutable value.
+   *
+   * @exception std::system_error with code @ref errc::common::invalid_argument if the options are
+   * not valid.
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  [[nodiscard]] auto build() const -> built
+  {
+    return { build_common_options(), ids_only_,         mutation_state_,
+             batch_byte_limit_,      batch_item_limit_, concurrency_ };
+  }
 
-  private:
-    bool ids_only_{ false };
-    std::vector<mutation_token> mutation_state_{};
-    std::optional<std::uint32_t> batch_byte_limit_{};
-    std::optional<std::uint32_t> batch_item_limit_{};
-    std::optional<std::uint16_t> concurrency_{};
+private:
+  bool ids_only_{ false };
+  std::vector<mutation_token> mutation_state_{};
+  std::optional<std::uint32_t> batch_byte_limit_{};
+  std::optional<std::uint32_t> batch_item_limit_{};
+  std::optional<std::uint16_t> concurrency_{};
 };
 
 /**
@@ -159,5 +165,5 @@ struct scan_options : public common_options<scan_options> {
  * @since 1.0.0
  * @volatile
  */
-using scan_handler = std::function<void(std::error_code, scan_result)>;
+using scan_handler = std::function<void(error, scan_result)>;
 } // namespace couchbase

data/ext/couchbase/couchbase/scan_result.hxx

@@ -17,6 +17,7 @@
 
 #pragma once
 
+#include <couchbase/error.hxx>
 #include <couchbase/scan_result_item.hxx>
 
 #include <future>
@@ -37,108 +38,108 @@ class internal_scan_result;
  * @since 1.0.0
  * @volatile
  */
-using scan_item_handler = std::function<void(std::error_code, std::optional<scan_result_item>)>;
+using scan_item_handler = std::function<void(error, std::optional<scan_result_item>)>;
 
 class scan_result
 {
+public:
+  /**
+   * Constructs an empty scan result.
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  scan_result() = default;
+
+  /**
+   * Constructs a scan result from an internal scan result.
+   *
+   * @param internal the internal scan result
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  explicit scan_result(std::shared_ptr<internal_scan_result> internal);
+
+  /**
+   * Fetches the next scan result item.
+   *
+   * @param handler callable that implements @ref scan_handler
+   *
+   * @since 1.0.0
+   * @volatile
+   */
+  void next(scan_item_handler&& handler) const;
+
+  /**
+   * Fetches the next scan result item.
+   *
+   * @return future object that carries the result of the operation
+   *
+   * @since 1.0.0
+   * @volatile
+   */
+  auto next() const -> std::future<std::pair<error, std::optional<scan_result_item>>>;
+
+  /**
+   * Cancels the scan.
+   *
+   * @since 1.0.0
+   * @volatile
+   */
+  void cancel();
+
+  /**
+   * An iterator that can be used to iterate through all the {@link scan_result_item}s.
+   *
+   * @since 1.0.0
+   * @volatile
+   */
+  class iterator
+  {
   public:
-    /**
-     * Constructs an empty scan result.
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    scan_result() = default;
-
-    /**
-     * Constructs a scan result from an internal scan result.
-     *
-     * @param internal the internal scan result
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    explicit scan_result(std::shared_ptr<internal_scan_result> internal);
-
-    /**
-     * Fetches the next scan result item.
-     *
-     * @param handler callable that implements @ref scan_handler
-     *
-     * @since 1.0.0
-     * @volatile
-     */
-    void next(scan_item_handler&& handler) const;
-
-    /**
-     * Fetches the next scan result item.
-     *
-     * @return future object that carries the result of the operation
-     *
-     * @since 1.0.0
-     * @volatile
-     */
-    auto next() const -> std::future<std::pair<std::error_code, std::optional<scan_result_item>>>;
-
-    /**
-     * Cancels the scan.
-     *
-     * @since 1.0.0
-     * @volatile
-     */
-    void cancel();
-
-    /**
-     * An iterator that can be used to iterate through all the {@link scan_result_item}s.
-     *
-     * @since 1.0.0
-     * @volatile
-     */
-    class iterator
-    {
-      public:
-        auto operator==(const iterator& other) const -> bool;
-        auto operator!=(const iterator& other) const -> bool;
-        auto operator*() -> std::pair<std::error_code, scan_result_item>;
-        auto operator++() -> iterator&;
-
-        explicit iterator(std::shared_ptr<internal_scan_result> internal);
-        explicit iterator(std::pair<std::error_code, scan_result_item> item);
-
-        using difference_type = std::ptrdiff_t;
-        using value_type = scan_result_item;
-        using pointer = const scan_result_item*;
-        using reference = const scan_result_item&;
-        using iterator_category = std::input_iterator_tag;
-
-      private:
-        void fetch_item();
-
-        std::shared_ptr<internal_scan_result> internal_{};
-        std::pair<std::error_code, scan_result_item> item_{};
-    };
-
-    /**
-     * Returns an iterator to the beginning.
-     *
-     * @return iterator to the beginning
-     *
-     * @since 1.0.0
-     * @volatile
-     */
-    auto begin() -> iterator;
-
-    /**
-     * Returns an iterator to the end.
-     *
-     * @return iterator to the end
-     *
-     * @since 1.0.0
-     * @volatile
-     */
-    auto end() -> iterator;
+    auto operator==(const iterator& other) const -> bool;
+    auto operator!=(const iterator& other) const -> bool;
+    auto operator*() -> std::pair<error, scan_result_item>;
+    auto operator++() -> iterator&;
+
+    explicit iterator(std::shared_ptr<internal_scan_result> internal);
+    explicit iterator(std::pair<error, scan_result_item> item);
+
+    using difference_type = std::ptrdiff_t;
+    using value_type = scan_result_item;
+    using pointer = const scan_result_item*;
+    using reference = const scan_result_item&;
+    using iterator_category = std::input_iterator_tag;
 
   private:
+    void fetch_item();
+
     std::shared_ptr<internal_scan_result> internal_{};
+    std::pair<error, scan_result_item> item_{};
+  };
+
+  /**
+   * Returns an iterator to the beginning.
+   *
+   * @return iterator to the beginning
+   *
+   * @since 1.0.0
+   * @volatile
+   */
+  auto begin() -> iterator;
+
+  /**
+   * Returns an iterator to the end.
+   *
+   * @return iterator to the end
+   *
+   * @since 1.0.0
+   * @volatile
+   */
+  auto end() -> iterator;
+
+private:
+  std::shared_ptr<internal_scan_result> internal_{};
 };
 } // namespace couchbase