x

Documentation

Overview

Package x is a generated protocol buffer package.

It is generated from these files:

x/x.proto

It has these top-level messages:

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

It is generated from these files:

x/x.proto

Index

• Constants
• func WriteError(resp http.ResponseWriter, err error)
• type HTTPClient
• type Svc1
  • func NewSvc1JSONClient(addr string, client HTTPClient) Svc1
  • func NewSvc1ProtobufClient(addr string, client HTTPClient) Svc1
• type TwirpServer
  • func NewSvc1Server(svc Svc1, hooks *twirp.ServerHooks) TwirpServer

Constants

const Svc1PathPrefix = "/twirp/twirp.internal.twirptest.importmapping.x.Svc1/"

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

Functions

func WriteError

func WriteError(resp http.ResponseWriter, err error)

WriteError writes an HTTP response with a valid Twirp error format. 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 Svc1

type Svc1 interface {
	Send(context.Context, *twirp_internal_twirptest_importmapping_y.MsgY) (*twirp_internal_twirptest_importmapping_y.MsgY, error)
}

func NewSvc1JSONClient

func NewSvc1JSONClient(addr string, client HTTPClient) Svc1

NewSvc1JSONClient creates a JSON client that implements the Svc1 interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewSvc1ProtobufClient

func NewSvc1ProtobufClient(addr string, client HTTPClient) Svc1

NewSvc1ProtobufClient creates a Protobuf client that implements the Svc1 interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

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
}

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 NewSvc1Server

func NewSvc1Server(svc Svc1, hooks *twirp.ServerHooks) TwirpServer