// Copyright 2010-2025 Google LLC // 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. #ifndef ORTOOLS_BASE_STATUS_BUILDER_H_ #define ORTOOLS_BASE_STATUS_BUILDER_H_ #include #include #include #include #include "absl/status/status.h" #include "absl/strings/str_cat.h" namespace util { class StatusBuilder { public: explicit StatusBuilder(const absl::StatusCode code) : base_status_(code, /*msg=*/{}) {} explicit StatusBuilder(const absl::Status status) : base_status_(std::move(status)) {} StatusBuilder(const StatusBuilder& other) : base_status_(other.base_status_), ss_(other.ss_.str(), std::ios_base::app) {} StatusBuilder& operator=(const StatusBuilder& other) { base_status_ = other.base_status_; ss_ = std::ostringstream(other.ss_.str(), std::ios_base::app); return *this; } StatusBuilder(StatusBuilder&& other) : base_status_(std::exchange(other.base_status_, absl::OkStatus())), ss_(std::move(other.ss_)) {} StatusBuilder& operator=(StatusBuilder&& other) { base_status_ = std::exchange(other.base_status_, absl::OkStatus()); ss_ = std::move(other.ss_); return *this; } operator absl::Status() const { // NOLINT const std::string annotation = ss_.str(); if (annotation.empty()) { return base_status_; } if (base_status_.message().empty()) { return absl::Status(base_status_.code(), annotation); } const std::string annotated_message = absl::StrCat(base_status_.message(), "; ", annotation); return absl::Status(base_status_.code(), annotated_message); } template StatusBuilder& operator<<(const T& t) { ss_ << t; return *this; } StatusBuilder& SetAppend() { return *this; } private: absl::Status base_status_; std::ostringstream ss_; }; inline StatusBuilder AbortedErrorBuilder() { return StatusBuilder(absl::StatusCode::kAborted); } inline StatusBuilder AlreadyExistsErrorBuilder() { return StatusBuilder(absl::StatusCode::kAlreadyExists); } inline StatusBuilder CancelledErrorBuilder() { return StatusBuilder(absl::StatusCode::kCancelled); } inline StatusBuilder DataLossErrorBuilder() { return StatusBuilder(absl::StatusCode::kDataLoss); } inline StatusBuilder DeadlineExceededErrorBuilder() { return StatusBuilder(absl::StatusCode::kDeadlineExceeded); } inline StatusBuilder FailedPreconditionErrorBuilder() { return StatusBuilder(absl::StatusCode::kFailedPrecondition); } inline StatusBuilder InternalErrorBuilder() { return StatusBuilder(absl::StatusCode::kInternal); } inline StatusBuilder InvalidArgumentErrorBuilder() { return StatusBuilder(absl::StatusCode::kInvalidArgument); } inline StatusBuilder NotFoundErrorBuilder() { return StatusBuilder(absl::StatusCode::kNotFound); } inline StatusBuilder OutOfRangeErrorBuilder() { return StatusBuilder(absl::StatusCode::kOutOfRange); } inline StatusBuilder PermissionDeniedErrorBuilder() { return StatusBuilder(absl::StatusCode::kPermissionDenied); } inline StatusBuilder UnauthenticatedErrorBuilder() { return StatusBuilder(absl::StatusCode::kUnauthenticated); } inline StatusBuilder ResourceExhaustedErrorBuilder() { return StatusBuilder(absl::StatusCode::kResourceExhausted); } inline StatusBuilder UnavailableErrorBuilder() { return StatusBuilder(absl::StatusCode::kUnavailable); } inline StatusBuilder UnimplementedErrorBuilder() { return StatusBuilder(absl::StatusCode::kUnimplemented); } inline StatusBuilder UnknownErrorBuilder() { return StatusBuilder(absl::StatusCode::kUnknown); } } // namespace util #endif // ORTOOLS_BASE_STATUS_BUILDER_H_