twirptest

Documentation

Index

• Constants
• Variables
• 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 (x *Hat) GetColor() string
  • func (x *Hat) GetName() string
  • func (x *Hat) GetSize() int32
  • func (*Hat) ProtoMessage()
  • func (x *Hat) ProtoReflect() protoreflect.Message
  • func (x *Hat) Reset()
  • func (x *Hat) String() string
• type Size
  • func (*Size) Descriptor() ([]byte, []int)
  • func (x *Size) GetInches() int32
  • func (*Size) ProtoMessage()
  • func (x *Size) ProtoReflect() protoreflect.Message
  • func (x *Size) Reset()
  • func (x *Size) String() string
• type TwirpServer
  • func NewHaberdasherServer(svc Haberdasher, opts ...interface{}) TwirpServer

Constants

const HaberdasherPathPrefix = "/twirp/twirp.internal.twirptest.Haberdasher/"

HaberdasherPathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html

Variables

var File_service_proto protoreflect.FileDescriptor

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

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

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 ErroringHatmaker

func ErroringHatmaker(err error) Haberdasher

Always errors.

func HaberdasherFunc

func HaberdasherFunc(f func(ctx context.Context, s *Size) (*Hat, error)) Haberdasher

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 NilHatmaker

func NilHatmaker() Haberdasher

Returns nil, nil

func NoopHatmaker

func NoopHatmaker() Haberdasher

Always makes a blank hat.

func PanickyHatmaker

func PanickyHatmaker(p interface{}) Haberdasher

Panics.

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"`
	// contains filtered or unexported fields
}

func (*Hat) Descriptor

func (*Hat) Descriptor() ([]byte, []int)

Deprecated: Use Hat.ProtoReflect.Descriptor instead.

func (*Hat) GetColor

func (x *Hat) GetColor() string

func (*Hat) GetName

func (x *Hat) GetName() string

func (*Hat) GetSize

func (x *Hat) GetSize() int32

func (*Hat) ProtoMessage

func (*Hat) ProtoMessage()

func (*Hat) ProtoReflect

func (x *Hat) ProtoReflect() protoreflect.Message

func (*Hat) Reset

func (x *Hat) Reset()

func (*Hat) String

func (x *Hat) String() string

type Size

type Size struct {
	Inches int32 `protobuf:"varint,1,opt,name=inches,proto3" json:"inches,omitempty"`
	// contains filtered or unexported fields
}

func (*Size) Descriptor

func (*Size) Descriptor() ([]byte, []int)

Deprecated: Use Size.ProtoReflect.Descriptor instead.

func (*Size) GetInches

func (x *Size) GetInches() int32

func (*Size) ProtoMessage

func (*Size) ProtoMessage()

func (*Size) ProtoReflect

func (x *Size) ProtoReflect() protoreflect.Message

func (*Size) Reset

func (x *Size) Reset()

func (*Size) String

func (x *Size) String() string

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
	// google.golang.org/protobuf/types/descriptorpb.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).