twirp: github.com/twitchtv/twirp/example Index | Files

package example

import "github.com/twitchtv/twirp/example"

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

It is generated from these files:

service.proto

Index

Package Files

gen.go service.pb.go service.twirp.go

Constants

const HaberdasherPathPrefix = "/twirp/twitch.twirp.example.Haberdasher/"

HaberdasherPathPrefix is used for all URL paths on a twirp Haberdasher server. Requests are always: POST HaberdasherPathPrefix/method It can be used in an HTTP mux to route twirp requests along with non-twirp requests on other routes.

func WriteError Uses

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)

type HTTPClient Uses

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 Uses

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 Uses

func NewHaberdasherJSONClient(addr 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 Uses

func NewHaberdasherProtobufClient(addr 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 Uses

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 Uses

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

func (*Hat) GetColor Uses

func (m *Hat) GetColor() string

func (*Hat) GetName Uses

func (m *Hat) GetName() string

func (*Hat) GetSize Uses

func (m *Hat) GetSize() int32

func (*Hat) ProtoMessage Uses

func (*Hat) ProtoMessage()

func (*Hat) Reset Uses

func (m *Hat) Reset()

func (*Hat) String Uses

func (m *Hat) String() string

func (*Hat) XXX_DiscardUnknown Uses

func (m *Hat) XXX_DiscardUnknown()

func (*Hat) XXX_Marshal Uses

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

func (*Hat) XXX_Merge Uses

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

func (*Hat) XXX_Size Uses

func (m *Hat) XXX_Size() int

func (*Hat) XXX_Unmarshal Uses

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

type Size Uses

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 Uses

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

func (*Size) GetInches Uses

func (m *Size) GetInches() int32

func (*Size) ProtoMessage Uses

func (*Size) ProtoMessage()

func (*Size) Reset Uses

func (m *Size) Reset()

func (*Size) String Uses

func (m *Size) String() string

func (*Size) XXX_DiscardUnknown Uses

func (m *Size) XXX_DiscardUnknown()

func (*Size) XXX_Marshal Uses

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

func (*Size) XXX_Merge Uses

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

func (*Size) XXX_Size Uses

func (m *Size) XXX_Size() int

func (*Size) XXX_Unmarshal Uses

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

type TwirpServer Uses

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
    // alongside non-twirp requests on one HTTP listener.
    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 Uses

func NewHaberdasherServer(svc Haberdasher, hooks *twirp.ServerHooks) TwirpServer

Package example imports 15 packages (graph) and is imported by 1 packages. Updated 2020-01-25. Refresh now. Tools for package owners.