example

Documentation

Overview

Package example is a generated twirp stub package. This code was generated with github.com/twitchtv/twirp/protoc-gen-twirp v7.0.0.

It is generated from these files:

service.proto

Index

• Constants
• func WriteError(resp http.ResponseWriter, err error)
• type HTTPClient
• type Haberdasher
  • func NewHaberdasherJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Haberdasher
  • func NewHaberdasherProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) 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
  • func NewHaberdasherServer(svc Haberdasher, opts ...interface{}) TwirpServer

Constants

const HaberdasherPathPrefix = "/twirp/twitch.twirp.example.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

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 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.

type Hat

type Hat struct {
	// The size of a hat should always be in inches.
	Size int32 `protobuf:"varint,1,opt,name=size,proto3" json:"size,omitempty"`
	// The color of a hat will never be 'invisible', but other than
	// that, anything is fair game.
	Color string `protobuf:"bytes,2,opt,name=color,proto3" json:"color,omitempty"`
	// The name of a hat is it's type. Like, 'bowler', or something.
	Name                 string   `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A Hat is a piece of headwear made by a Haberdasher.

func (*Hat) Descriptor

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

func (*Hat) GetColor

func (m *Hat) GetColor() string

func (*Hat) GetName

func (m *Hat) GetName() string

func (*Hat) GetSize

func (m *Hat) GetSize() int32

func (*Hat) ProtoMessage

func (*Hat) ProtoMessage()

func (*Hat) Reset

func (m *Hat) Reset()

func (*Hat) String

func (m *Hat) String() string

func (*Hat) XXX_DiscardUnknown

func (m *Hat) XXX_DiscardUnknown()

func (*Hat) XXX_Marshal

func (m *Hat) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Hat) XXX_Merge

func (m *Hat) XXX_Merge(src proto.Message)

func (*Hat) XXX_Size

func (m *Hat) XXX_Size() int

func (*Hat) XXX_Unmarshal

func (m *Hat) XXX_Unmarshal(b []byte) error

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:"-"`
}

Size is passed when requesting a new hat to be made. It's always measured in inches.

func (*Size) Descriptor

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

func (*Size) GetInches

func (m *Size) GetInches() int32

func (*Size) ProtoMessage

func (*Size) ProtoMessage()

func (*Size) Reset

func (m *Size) Reset()

func (*Size) String

func (m *Size) String() string

func (*Size) XXX_DiscardUnknown

func (m *Size) XXX_DiscardUnknown()

func (*Size) XXX_Marshal

func (m *Size) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Size) XXX_Merge

func (m *Size) XXX_Merge(src proto.Message)

func (*Size) XXX_Size

func (m *Size) XXX_Size() int

func (*Size) XXX_Unmarshal

func (m *Size) XXX_Unmarshal(b []byte) error

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).