go.uber.org/yarpc@v1.72.1/encoding/thrift/response.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 thrift
    22  
    23  import (
    24  	"go.uber.org/thriftrw/envelope"
    25  	"go.uber.org/thriftrw/protocol/stream"
    26  	"go.uber.org/yarpc/yarpcerrors"
    27  )
    28  
    29  // Response contains the raw response from a generated Thrift handler.
    30  type Response struct {
    31  	Body envelope.Enveloper
    32  
    33  	IsApplicationError bool
    34  
    35  	ApplicationErrorDetails string
    36  	ApplicationErrorName    string
    37  	ApplicationErrorCode    *yarpcerrors.Code
    38  }
    39  
    40  // NoWireResponse is the response from a generated Thrift handler that can
    41  // process requests that use the "nowire" implementation.
    42  type NoWireResponse struct {
    43  	// Body contains the response body. It knows how to encode itself into
    44  	// the "nowire" representation.
    45  	Body stream.Enveloper
    46  
    47  	// ResponseWriter encodes the body into an output stream.
    48  	ResponseWriter stream.ResponseWriter
    49  
    50  	// IsApplicationError reports whether the response indicates an
    51  	// appliation-level error. If true, a Thrift exception was thrown by
    52  	// the handler.
    53  	IsApplicationError bool
    54  
    55  	ApplicationErrorDetails string
    56  	ApplicationErrorName    string
    57  	ApplicationErrorCode    *yarpcerrors.Code
    58  }