Documentation ¶
Overview ¶
package twirptest provides servers for use in tests and for testing the cleanliness of the generated output of protoc-gen-twirp.
Package twirptest is a generated twirp stub package. This code was generated with github.com/twitchtv/twirp/protoc-gen-twirp v7.2.0.
It is generated from these files:
service.proto
Index ¶
- Constants
- func WriteError(resp http.ResponseWriter, err error)
- type HTTPClient
- type Haberdasher
- func ErroringHatmaker(err error) Haberdasher
- func HaberdasherFunc(f func(ctx context.Context, s *Size) (*Hat, error)) Haberdasher
- func NewHaberdasherJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Haberdasher
- func NewHaberdasherProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Haberdasher
- func NilHatmaker() Haberdasher
- func NoopHatmaker() Haberdasher
- func PanickyHatmaker(p interface{}) Haberdasher
- func PickyHatmaker(want int32) Haberdasher
- func ServerAndClient(h Haberdasher, hooks *twirp.ServerHooks) (*httptest.Server, Haberdasher)
- func SlowHatmaker(dur time.Duration) Haberdasher
- func TwirpServerAndClient(hooks *twirp.ServerHooks) (*httptest.Server, Haberdasher)
- type Hat
- func (*Hat) Descriptor() ([]byte, []int)
- func (m *Hat) GetColor() string
- func (m *Hat) GetName() string
- func (m *Hat) GetSize() int32
- func (*Hat) ProtoMessage()
- func (m *Hat) Reset()
- func (m *Hat) String() string
- func (m *Hat) XXX_DiscardUnknown()
- func (m *Hat) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Hat) XXX_Merge(src proto.Message)
- func (m *Hat) XXX_Size() int
- func (m *Hat) XXX_Unmarshal(b []byte) error
- type Size
- func (*Size) Descriptor() ([]byte, []int)
- func (m *Size) GetInches() int32
- func (*Size) ProtoMessage()
- func (m *Size) Reset()
- func (m *Size) String() string
- func (m *Size) XXX_DiscardUnknown()
- func (m *Size) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Size) XXX_Merge(src proto.Message)
- func (m *Size) XXX_Size() int
- func (m *Size) XXX_Unmarshal(b []byte) error
- type TwirpServer
Constants ¶
const HaberdasherPathPrefix = "/twirp/twirp.internal.twirptest.Haberdasher/"
HaberdasherPathPrefix is a convenience constant that could used to identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, that add a "/twirp" prefix by default, and use CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html
Variables ¶
This section is empty.
Functions ¶
func WriteError ¶
func WriteError(resp http.ResponseWriter, err error)
WriteError writes an HTTP response with a valid Twirp error format (code, msg, meta). Useful outside of the Twirp server (e.g. http middleware), but does not trigger hooks. If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err)
Types ¶
type HTTPClient ¶
HTTPClient is the interface used by generated clients to send HTTP requests. It is fulfilled by *(net/http).Client, which is sufficient for most users. Users can provide their own implementation for special retry policies.
HTTPClient implementations should not follow redirects. Redirects are automatically disabled if *(net/http).Client is passed to client constructors. See the withoutRedirects function in this file for more details.
type Haberdasher ¶
type Haberdasher interface { // MakeHat produces a hat of mysterious, randomly-selected color! MakeHat(context.Context, *Size) (*Hat, error) }
A Haberdasher makes hats for clients.
func HaberdasherFunc ¶
HaberdasherFunc is a convenience to convert a function into a Haberdasher service.
func NewHaberdasherJSONClient ¶
func NewHaberdasherJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Haberdasher
NewHaberdasherJSONClient creates a JSON client that implements the Haberdasher interface. It communicates using JSON and can be configured with a custom HTTPClient.
func NewHaberdasherProtobufClient ¶
func NewHaberdasherProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Haberdasher
NewHaberdasherProtobufClient creates a Protobuf client that implements the Haberdasher interface. It communicates using Protobuf and can be configured with a custom HTTPClient.
func PickyHatmaker ¶
func PickyHatmaker(want int32) Haberdasher
Makes a hat, as long as its the size they like
func ServerAndClient ¶
func ServerAndClient(h Haberdasher, hooks *twirp.ServerHooks) (*httptest.Server, Haberdasher)
func SlowHatmaker ¶
func SlowHatmaker(dur time.Duration) Haberdasher
Makes a hat, but sure takes their time
func TwirpServerAndClient ¶
func TwirpServerAndClient(hooks *twirp.ServerHooks) (*httptest.Server, Haberdasher)
type Hat ¶
type Hat struct { Size int32 `protobuf:"varint,1,opt,name=size,proto3" json:"size,omitempty"` Color string `protobuf:"bytes,2,opt,name=color,proto3" json:"color,omitempty"` Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*Hat) Descriptor ¶
func (*Hat) ProtoMessage ¶
func (*Hat) ProtoMessage()
func (*Hat) XXX_DiscardUnknown ¶
func (m *Hat) XXX_DiscardUnknown()
func (*Hat) XXX_Unmarshal ¶
type Size ¶
type Size struct { Inches int32 `protobuf:"varint,1,opt,name=inches,proto3" json:"inches,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*Size) Descriptor ¶
func (*Size) ProtoMessage ¶
func (*Size) ProtoMessage()
func (*Size) XXX_DiscardUnknown ¶
func (m *Size) XXX_DiscardUnknown()
func (*Size) XXX_Unmarshal ¶
type TwirpServer ¶
type TwirpServer interface { http.Handler // ServiceDescriptor returns gzipped bytes describing the .proto file that // this service was generated from. Once unzipped, the bytes can be // unmarshalled as a // github.com/golang/protobuf/protoc-gen-go/descriptor.FileDescriptorProto. // // The returned integer is the index of this particular service within that // FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a // low-level field, expected to be used for reflection. ServiceDescriptor() ([]byte, int) // ProtocGenTwirpVersion is the semantic version string of the version of // twirp used to generate this file. ProtocGenTwirpVersion() string // PathPrefix returns the HTTP URL path prefix for all methods handled by this // service. This can be used with an HTTP mux to route Twirp requests. // The path prefix is in the form: "/<prefix>/<package>.<Service>/" // that is, everything in a Twirp route except for the <Method> at the end. PathPrefix() string }
TwirpServer is the interface generated server structs will support: they're HTTP handlers with additional methods for accessing metadata about the service. Those accessors are a low-level API for building reflection tools. Most people can think of TwirpServers as just http.Handlers.
func NewHaberdasherServer ¶
func NewHaberdasherServer(svc Haberdasher, opts ...interface{}) TwirpServer
NewHaberdasherServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package empty_service is a generated twirp stub package.
|
Package empty_service is a generated twirp stub package. |
Package gogo_compat is a generated protocol buffer package.
|
Package gogo_compat is a generated protocol buffer package. |
Package google_protobuf_imports is a generated twirp stub package.
|
Package google_protobuf_imports is a generated twirp stub package. |
Package importable is a generated twirp stub package.
|
Package importable is a generated twirp stub package. |
Package importer is a generated twirp stub package.
|
Package importer is a generated twirp stub package. |
Package importer_local is a generated twirp stub package.
|
Package importer_local is a generated twirp stub package. |
x
Package x is a generated twirp stub package.
|
Package x is a generated twirp stub package. |
Package json_serialization is a generated twirp stub package.
|
Package json_serialization is a generated twirp stub package. |
Package multiple is a generated twirp stub package.
|
Package multiple is a generated twirp stub package. |
Package no_package_name is a generated twirp stub package.
|
Package no_package_name is a generated twirp stub package. |
Package no_package_name_importer is a generated twirp stub package.
|
Package no_package_name_importer is a generated twirp stub package. |
Package proto is a generated twirp stub package.
|
Package proto is a generated twirp stub package. |
Package service_method_same_name is a generated twirp stub package.
|
Package service_method_same_name is a generated twirp stub package. |
Package snake_case_names is a generated twirp stub package.
|
Package snake_case_names is a generated twirp stub package. |
Package source_relative is a generated twirp stub package.
|
Package source_relative is a generated twirp stub package. |