include/grpcpp/support/error_details.h

   1 /*
   2  *
   3  * Copyright 2017 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #ifndef GRPCPP_SUPPORT_ERROR_DETAILS_H
  20 #define GRPCPP_SUPPORT_ERROR_DETAILS_H
  21
  22 #include <grpcpp/support/status.h>
  23
  24 namespace grpc {
  25
  26 /// Map a \a grpc::Status to a \a google::rpc::Status.
  27 /// The given \a to object will be cleared.
  28 /// On success, returns status with OK.
  29 /// Returns status with \a INVALID_ARGUMENT, if failed to deserialize.
  30 /// Returns status with \a FAILED_PRECONDITION, if \a to is nullptr.
  31 ///
  32 /// \note
  33 /// This function is a template to avoid a build dep on \a status.proto.
  34 /// However, this function still requires that \tparam T is of type
  35 /// \a google::rpc::Status, which is defined at
  36 /// https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto
  37 template <typename T>
  38 grpc::Status ExtractErrorDetails(const grpc::Status& from, T* to) {
  39   if (to == nullptr) {
  40     return grpc::Status(grpc::StatusCode::FAILED_PRECONDITION, "");
  41   }
  42   if (!to->ParseFromString(from.error_details())) {
  43     return grpc::Status(grpc::StatusCode::INVALID_ARGUMENT, "");
  44   }
  45   return grpc::Status::OK;
  46 }
  47 inline grpc::Status ExtractErrorDetails(const grpc::Status&, std::nullptr_t) {
  48   return grpc::Status(grpc::StatusCode::FAILED_PRECONDITION, "");
  49 }
  50
  51 /// Map \a google::rpc::Status to a \a grpc::Status.
  52 /// Returns OK on success.
  53 /// Returns status with \a FAILED_PRECONDITION if \a to is nullptr.
  54 ///
  55 /// \note
  56 /// This function is a template to avoid a build dep on \a status.proto.
  57 /// However, this function still requires that \tparam T is of type
  58 /// \a google::rpc::Status, which is defined at
  59 /// https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto
  60 template <typename T>
  61 grpc::Status SetErrorDetails(const T& from, grpc::Status* to) {
  62   if (to == nullptr) {
  63     return grpc::Status(grpc::StatusCode::FAILED_PRECONDITION, "");
  64   }
  65   grpc::StatusCode code = grpc::StatusCode::UNKNOWN;
  66   if (from.code() >= grpc::StatusCode::OK &&
  67       from.code() <= grpc::StatusCode::UNAUTHENTICATED) {
  68     code = static_cast<grpc::StatusCode>(from.code());
  69   }
  70   *to = grpc::Status(code, from.message(), from.SerializeAsString());
  71   return grpc::Status::OK;
  72 }
  73
  74 }  // namespace grpc
  75
  76 #endif  // GRPCPP_SUPPORT_ERROR_DETAILS_H