go.uber.org/yarpc@v1.72.1/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 yarpc
    22  
    23  import "go.uber.org/yarpc/yarpcerrors"
    24  
    25  // IsBadRequestError returns true on an error returned by RPC clients if the
    26  // request was rejected by YARPC because it was invalid.
    27  //
    28  // 	res, err := client.Call(...)
    29  // 	if yarpc.IsBadRequestError(err) {
    30  // 		fmt.Println("invalid request:", err)
    31  // 	}
    32  //
    33  // Deprecated: use yarpcerrors.FromError(err).Code() == yarpcerrors.CodeInvalidArgument instead.
    34  func IsBadRequestError(err error) bool {
    35  	return yarpcerrors.FromError(err).Code() == yarpcerrors.CodeInvalidArgument
    36  }
    37  
    38  // IsUnexpectedError returns true on an error returned by RPC clients if the
    39  // server panicked or failed with an unhandled error.
    40  //
    41  // 	res, err := client.Call(...)
    42  // 	if yarpc.IsUnexpectedError(err) {
    43  // 		fmt.Println("internal server error:", err)
    44  // 	}
    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 returns true on an error returned by RPC clients if the given
    52  // error is a TimeoutError.
    53  //
    54  // 	res, err := client.Call(...)
    55  // 	if yarpc.IsTimeoutError(err) {
    56  // 		fmt.Println("request timed out:", err)
    57  // 	}
    58  //
    59  // Deprecated: use yarpcerrors.FromError(err).Code() == yarpcerrors.CodeDeadlineExceeded instead.
    60  func IsTimeoutError(err error) bool {
    61  	return yarpcerrors.FromError(err).Code() == yarpcerrors.CodeDeadlineExceeded
    62  }