error_context.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2024. 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 <memory>
#include <string>
 
namespace couchbase
{
enum class error_context_json_format {
  compact = 0,
  pretty,
};
 
struct internal_error_context;
 
class error_context
{
public:
  error_context() = default;
 
  explicit operator bool() const;
 
  [[nodiscard]] auto to_json(
    error_context_json_format format = error_context_json_format::compact) const -> std::string;
 
  [[nodiscard]] auto impl() const -> std::shared_ptr<internal_error_context>;
 
private:
  friend struct internal_error_context;
  explicit error_context(std::shared_ptr<internal_error_context> impl);
 
  std::shared_ptr<internal_error_context> impl_{ nullptr };
};
} // namespace couchbase