go.uber.org/yarpc@v1.72.1/yarpcerrors/yarpcerrorclassifier.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 yarpcerrors
    22  
    23  type fault int
    24  
    25  const (
    26  	UnknownFault fault = iota
    27  	ClientFault
    28  	ServerFault
    29  )
    30  
    31  // GetFaultTypeFromError determines whether the error is a client, server or indeterminate fault based on a YARPC Code.
    32  func GetFaultTypeFromError(err error) fault {
    33  	return GetFaultTypeFromCode(FromError(err).Code())
    34  }
    35  
    36  // GetFaultTypeFromCode determines whether the status code is a client, server or indeterminate fault based on a YARPC Code.
    37  func GetFaultTypeFromCode(code Code) fault {
    38  	switch code {
    39  	case CodeCancelled,
    40  		CodeInvalidArgument,
    41  		CodeNotFound,
    42  		CodeAlreadyExists,
    43  		CodePermissionDenied,
    44  		CodeFailedPrecondition,
    45  		CodeAborted,
    46  		CodeOutOfRange,
    47  		CodeUnauthenticated,
    48  		CodeUnimplemented,
    49  		CodeResourceExhausted:
    50  		return ClientFault
    51  
    52  	case CodeUnknown,
    53  		CodeDeadlineExceeded,
    54  		CodeInternal,
    55  		CodeUnavailable,
    56  		CodeDataLoss:
    57  		return ServerFault
    58  	}
    59  
    60  	return UnknownFault
    61  }