status.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2017 The Apollo Authors. All Rights Reserved.
 *
 * 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 <string>

#include "google/protobuf/descriptor.h"
#include "modules/common/proto/error_code.pb.h"
#include "modules/common/util/future.h"

namespace apollo {
namespace common {

class Status {
 public:
  explicit Status(ErrorCode code = ErrorCode::OK, std::string_view msg = "")
      : code_(code), msg_(msg.data()) {}

  ~Status() = default;

  static Status OK() { return Status(); }

  bool ok() const { return code_ == ErrorCode::OK; }

  ErrorCode code() const { return code_; }

  bool operator==(const Status &rh) const {
    return (this->code_ == rh.code_) && (this->msg_ == rh.msg_);
  }

  bool operator!=(const Status &rh) const { return !(*this == rh); }

  const std::string &error_message() const { return msg_; }

  std::string ToString() const {
    if (ok()) {
      return "OK";
    }
    return ErrorCode_Name(code_) + ": " + msg_;
  }

  void Save(StatusPb *status_pb) {
    if (!status_pb) {
      return;
    }
    status_pb->set_error_code(code_);
    if (!msg_.empty()) {
      status_pb->set_msg(msg_);
    }
  }

 private:
  ErrorCode code_;
  std::string msg_;
};

inline std::ostream &operator<<(std::ostream &os, const Status &s) {
  os << s.ToString();
  return os;
}

}  // namespace common
}  // namespace apollo