status_internal.h 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. // Copyright 2019 The Abseil Authors.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // https://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. #ifndef ABSL_STATUS_INTERNAL_STATUS_INTERNAL_H_
  15. #define ABSL_STATUS_INTERNAL_STATUS_INTERNAL_H_
  16. #include <memory>
  17. #include <string>
  18. #include <utility>
  19. #include "absl/base/attributes.h"
  20. #include "absl/container/inlined_vector.h"
  21. #include "absl/strings/cord.h"
  22. #ifndef SWIG
  23. // Disabled for SWIG as it doesn't parse attributes correctly.
  24. namespace absl {
  25. ABSL_NAMESPACE_BEGIN
  26. // Returned Status objects may not be ignored. Codesearch doesn't handle ifdefs
  27. // as part of a class definitions (b/6995610), so we use a forward declaration.
  28. //
  29. // TODO(b/176172494): ABSL_MUST_USE_RESULT should expand to the more strict
  30. // [[nodiscard]]. For now, just use [[nodiscard]] directly when it is available.
  31. #if ABSL_HAVE_CPP_ATTRIBUTE(nodiscard)
  32. class [[nodiscard]] Status;
  33. #else
  34. class ABSL_MUST_USE_RESULT Status;
  35. #endif
  36. ABSL_NAMESPACE_END
  37. } // namespace absl
  38. #endif // !SWIG
  39. namespace absl {
  40. ABSL_NAMESPACE_BEGIN
  41. enum class StatusCode : int;
  42. namespace status_internal {
  43. // Container for status payloads.
  44. struct Payload {
  45. std::string type_url;
  46. absl::Cord payload;
  47. };
  48. using Payloads = absl::InlinedVector<Payload, 1>;
  49. // Reference-counted representation of Status data.
  50. struct StatusRep {
  51. StatusRep(absl::StatusCode code_arg, absl::string_view message_arg,
  52. std::unique_ptr<status_internal::Payloads> payloads_arg)
  53. : ref(int32_t{1}),
  54. code(code_arg),
  55. message(message_arg),
  56. payloads(std::move(payloads_arg)) {}
  57. std::atomic<int32_t> ref;
  58. absl::StatusCode code;
  59. std::string message;
  60. std::unique_ptr<status_internal::Payloads> payloads;
  61. };
  62. absl::StatusCode MapToLocalCode(int value);
  63. // Returns a pointer to a newly-allocated string with the given `prefix`,
  64. // suitable for output as an error message in assertion/`CHECK()` failures.
  65. //
  66. // This is an internal implementation detail for Abseil logging.
  67. std::string* MakeCheckFailString(const absl::Status* status,
  68. const char* prefix);
  69. } // namespace status_internal
  70. ABSL_NAMESPACE_END
  71. } // namespace absl
  72. #endif // ABSL_STATUS_INTERNAL_STATUS_INTERNAL_H_