src/lib/util/status.h

// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COBALT_SRC_LIB_UTIL_STATUS_H_
#define COBALT_SRC_LIB_UTIL_STATUS_H_

#include <string>

#include "src/lib/util/status_codes.h"

namespace cobalt {
namespace util {

class Status {
 public:
  Status() = default;

  Status(StatusCode code, std::string error_message)
      : code_(code), error_message_(std::move(error_message)) {}

  Status(StatusCode code, std::string error_message, std::string error_details)
      : code_(code),
        error_message_(std::move(error_message)),
        error_details_(std::move(error_details)) {}

  // Pre-defined special status objects.
  static const Status &OK;
  static const Status &CANCELLED;

  [[nodiscard]] StatusCode error_code() const { return code_; }
  [[nodiscard]] std::string error_message() const { return error_message_; }
  [[nodiscard]] std::string error_details() const { return error_details_; }

  [[nodiscard]] bool ok() const { return code_ == StatusCode::OK; }

  // Ignores any errors. This method does nothing except potentially suppress
  // complaints from any tools that are checking that errors are not dropped on
  // the floor.
  void IgnoreError() {}

 private:
  StatusCode code_ = StatusCode::OK;
  std::string error_message_;
  std::string error_details_;
};

}  // namespace util
}  // namespace cobalt

#endif  // COBALT_SRC_LIB_UTIL_STATUS_H_