go.uber.org/yarpc@v1.72.1/api/transport/errors.go (about)

     1  // Copyright (c) 2022 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package transport
    22  
    23  import "go.uber.org/yarpc/yarpcerrors"
    24  
    25  // InboundBadRequestError builds an error which indicates that an inbound
    26  // cannot process a request because it is a bad request.
    27  //
    28  // IsBadRequestError returns true for these errors.
    29  //
    30  // Deprecated: use yarpcerrors.Newf with yarpcerrors.CodeInvalidArgument instead.
    31  func InboundBadRequestError(err error) error {
    32  	return yarpcerrors.Newf(yarpcerrors.CodeInvalidArgument, err.Error())
    33  }
    34  
    35  // IsBadRequestError returns true if the request could not be processed
    36  // because it was invalid.
    37  //
    38  // Deprecated: use yarpcerrors.FromError(err).Code() == yarpcerrors.CodeInvalidArgument instead.
    39  func IsBadRequestError(err error) bool {
    40  	return yarpcerrors.FromError(err).Code() == yarpcerrors.CodeInvalidArgument
    41  }
    42  
    43  // IsUnexpectedError returns true if the server panicked or failed to process
    44  // the request with an unhandled error.
    45  //
    46  // Deprecated: use yarpcerrors.FromError(err).Code() == yarpcerrors.CodeInternal instead.
    47  func IsUnexpectedError(err error) bool {
    48  	return yarpcerrors.FromError(err).Code() == yarpcerrors.CodeInternal
    49  }
    50  
    51  // IsTimeoutError return true if the given error is a TimeoutError.
    52  //
    53  // Deprecated: use yarpcerrors.FromError(err).Code() == yarpcerrors.CodeDeadlineExceeded instead.
    54  func IsTimeoutError(err error) bool {
    55  	return yarpcerrors.FromError(err).Code() == yarpcerrors.CodeDeadlineExceeded
    56  }
    57  
    58  // UnrecognizedProcedureError returns an error for the given request,
    59  // such that IsUnrecognizedProcedureError can distinguish it from other errors
    60  // coming out of router.Choose.
    61  //
    62  // Deprecated: use yarpcerrors.Newf with yarpcerrors.CodeUnimplemented instead.
    63  func UnrecognizedProcedureError(req *Request) error {
    64  	return yarpcerrors.Newf(yarpcerrors.CodeUnimplemented, "unrecognized procedure %q for service %q", req.Procedure, req.Service)
    65  }
    66  
    67  // IsUnrecognizedProcedureError returns true for errors returned by
    68  // Router.Choose if the router cannot find a handler for the request.
    69  //
    70  // Deprecated: use yarpcerrors.FromError(err).Code() == yarpcerrors.CodeUnimplemented instead.
    71  func IsUnrecognizedProcedureError(err error) bool {
    72  	return yarpcerrors.FromError(err).Code() == yarpcerrors.CodeUnimplemented
    73  }