diff options
author | 2020-02-20 12:34:37 -0800 | |
---|---|---|
committer | 2020-02-20 15:37:22 -0500 | |
commit | 914ff44510505f209d8e85a01e31f4c5fb1b6a5b (patch) | |
tree | 1214a2d25654bd73cdecf18f77798ab044beb369 /absl/status/status_payload_printer.h | |
parent | 3c814105108680997d0821077694f663693b5382 (diff) |
Export of internal Abseil changes
--
bffb14058bb46137d42c7a113a36b6b582997cda by Xiaoyi Zhang <zhangxy@google.com>:
Add ABSL_MUST_USE_RESULT to Status.
PiperOrigin-RevId: 296272498
--
b426fdd3b3f687d7a8aeb644925923bbab503778 by CJ Johnson <johnsoncj@google.com>:
Optimizes absl::InlinedVector::clear() by not deallocating the data, if allocated. This allows allocations to be reused.
This matches the behavior of std::vector::clear()
PiperOrigin-RevId: 296197235
--
8cb9fbfe20e749816065c1a042e84f72dac9bfc0 by CJ Johnson <johnsoncj@google.com>:
Optimizes absl::InlinedVector::clear() by not deallocating the data, if allocated. This allows allocations to be reused.
This matches the behavior of std::vector::clear()
PiperOrigin-RevId: 296058092
--
2558d3369a482879919155b6f46317ccafe0ca13 by Matthew Brown <matthewbr@google.com>:
Internal cleanup
PiperOrigin-RevId: 296025806
--
cf7ee57228534021c15ed7421df92acf6c27c9c7 by Gennadiy Rozental <rogeeff@google.com>:
Make FlagOps enum class.
We also add comments to all the functions used to invoke flag ops.
PiperOrigin-RevId: 295975809
--
74bbdbd12fbc54e9c4ebcb3005e727becf0e509d by Xiaoyi Zhang <zhangxy@google.com>:
Release `absl::Status`.
PiperOrigin-RevId: 295777662
--
3dbc622b4e2227863525da2f7de7ecbeb3ede21f by Xiaoyi Zhang <zhangxy@google.com>:
Internal change.
PiperOrigin-RevId: 295733658
--
48d74aa0ab01d611da6012b377f038d8b26c712e by Abseil Team <absl-team@google.com>:
Fix typo in container/CMakeLists.txt for container_common
PiperOrigin-RevId: 295491438
GitOrigin-RevId: bffb14058bb46137d42c7a113a36b6b582997cda
Change-Id: Ia966857b07fa7412cd6489ac37b5fa26640e4141
Diffstat (limited to 'absl/status/status_payload_printer.h')
-rw-r--r-- | absl/status/status_payload_printer.h | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/absl/status/status_payload_printer.h b/absl/status/status_payload_printer.h new file mode 100644 index 00000000..5e0937f6 --- /dev/null +++ b/absl/status/status_payload_printer.h @@ -0,0 +1,51 @@ +// Copyright 2019 The Abseil Authors. +// +// 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 +// +// https://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 ABSL_STATUS_STATUS_PAYLOAD_PRINTER_H_ +#define ABSL_STATUS_STATUS_PAYLOAD_PRINTER_H_ + +#include <string> + +#include "absl/strings/cord.h" +#include "absl/strings/string_view.h" +#include "absl/types/optional.h" + +namespace absl { +ABSL_NAMESPACE_BEGIN +namespace status_internal { + +// By default, `Status::ToString` and `operator<<(Status)` print a payload by +// dumping the type URL and the raw bytes. To help debugging, we provide an +// extension point, which is a global printer function that can be set by users +// to specify how to print payloads. The function takes the type URL and the +// payload as input, and should return a valid human-readable string on success +// or `absl::nullopt` on failure (in which case it falls back to the default +// approach of printing the raw bytes). +// NOTE: This is an internal API and the design is subject to change in the +// future in a non-backward-compatible way. Since it's only meant for debugging +// purpose, you should not rely on it in any critical logic. +using StatusPayloadPrinter = absl::optional<std::string> (*)(absl::string_view, + const absl::Cord&); + +// Sets the global payload printer. Only one printer should be set per process. +// If multiple printers are set, it's undefined which one will be used. +void SetStatusPayloadPrinter(StatusPayloadPrinter); + +// Returns the global payload printer if previously set, otherwise `nullptr`. +StatusPayloadPrinter GetStatusPayloadPrinter(); + +} // namespace status_internal +ABSL_NAMESPACE_END +} // namespace absl + +#endif // ABSL_STATUS_STATUS_PAYLOAD_PRINTER_H_ |