snake_case_names

Documentation

Index

• Constants
• Variables
• func WriteError(resp http.ResponseWriter, err error)
• type HTTPClient
• type HaberdasherV1
  • func NewHaberdasherV1JSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) HaberdasherV1
  • func NewHaberdasherV1ProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) HaberdasherV1
• type MakeHatArgsV1
  • func (*MakeHatArgsV1) Descriptor() ([]byte, []int)
  • func (*MakeHatArgsV1) ProtoMessage()
  • func (x *MakeHatArgsV1) ProtoReflect() protoreflect.Message
  • func (x *MakeHatArgsV1) Reset()
  • func (x *MakeHatArgsV1) String() string
• type MakeHatArgsV1_HatV1
  • func (*MakeHatArgsV1_HatV1) Descriptor() ([]byte, []int)
  • func (x *MakeHatArgsV1_HatV1) GetColor() string
  • func (x *MakeHatArgsV1_HatV1) GetName() string
  • func (x *MakeHatArgsV1_HatV1) GetSize() int32
  • func (*MakeHatArgsV1_HatV1) ProtoMessage()
  • func (x *MakeHatArgsV1_HatV1) ProtoReflect() protoreflect.Message
  • func (x *MakeHatArgsV1_HatV1) Reset()
  • func (x *MakeHatArgsV1_HatV1) String() string
• type MakeHatArgsV1_SizeV1
  • func (*MakeHatArgsV1_SizeV1) Descriptor() ([]byte, []int)
  • func (x *MakeHatArgsV1_SizeV1) GetInches() int32
  • func (*MakeHatArgsV1_SizeV1) ProtoMessage()
  • func (x *MakeHatArgsV1_SizeV1) ProtoReflect() protoreflect.Message
  • func (x *MakeHatArgsV1_SizeV1) Reset()
  • func (x *MakeHatArgsV1_SizeV1) String() string
• type TwirpServer
  • func NewHaberdasherV1Server(svc HaberdasherV1, opts ...interface{}) TwirpServer

Constants

const HaberdasherV1PathPrefix = "/twirp/twirp.internal.twirptest.snake_case_names.HaberdasherV1/"

HaberdasherV1PathPrefix 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_snake_case_names_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 HaberdasherV1

type HaberdasherV1 interface {
	MakeHatV1(context.Context, *MakeHatArgsV1_SizeV1) (*MakeHatArgsV1_HatV1, error)
}

A Haberdasher makes hats for clients.

func NewHaberdasherV1JSONClient

func NewHaberdasherV1JSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) HaberdasherV1

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

func NewHaberdasherV1ProtobufClient

func NewHaberdasherV1ProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) HaberdasherV1

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

type MakeHatArgsV1

type MakeHatArgsV1 struct {
	// contains filtered or unexported fields
}

func (*MakeHatArgsV1) Descriptor

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

Deprecated: Use MakeHatArgsV1.ProtoReflect.Descriptor instead.

func (*MakeHatArgsV1) ProtoMessage

func (*MakeHatArgsV1) ProtoMessage()

func (*MakeHatArgsV1) ProtoReflect

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

func (*MakeHatArgsV1) Reset

func (x *MakeHatArgsV1) Reset()

func (*MakeHatArgsV1) String

func (x *MakeHatArgsV1) String() string

type MakeHatArgsV1_HatV1

type MakeHatArgsV1_HatV1 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 (*MakeHatArgsV1_HatV1) Descriptor

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

Deprecated: Use MakeHatArgsV1_HatV1.ProtoReflect.Descriptor instead.

func (*MakeHatArgsV1_HatV1) GetColor

func (x *MakeHatArgsV1_HatV1) GetColor() string

func (*MakeHatArgsV1_HatV1) GetName

func (x *MakeHatArgsV1_HatV1) GetName() string

func (*MakeHatArgsV1_HatV1) GetSize

func (x *MakeHatArgsV1_HatV1) GetSize() int32

func (*MakeHatArgsV1_HatV1) ProtoMessage

func (*MakeHatArgsV1_HatV1) ProtoMessage()

func (*MakeHatArgsV1_HatV1) ProtoReflect

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

func (*MakeHatArgsV1_HatV1) Reset

func (x *MakeHatArgsV1_HatV1) Reset()

func (*MakeHatArgsV1_HatV1) String

func (x *MakeHatArgsV1_HatV1) String() string

type MakeHatArgsV1_SizeV1

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

func (*MakeHatArgsV1_SizeV1) Descriptor

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

Deprecated: Use MakeHatArgsV1_SizeV1.ProtoReflect.Descriptor instead.

func (*MakeHatArgsV1_SizeV1) GetInches

func (x *MakeHatArgsV1_SizeV1) GetInches() int32

func (*MakeHatArgsV1_SizeV1) ProtoMessage

func (*MakeHatArgsV1_SizeV1) ProtoMessage()

func (*MakeHatArgsV1_SizeV1) ProtoReflect

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

func (*MakeHatArgsV1_SizeV1) Reset

func (x *MakeHatArgsV1_SizeV1) Reset()

func (*MakeHatArgsV1_SizeV1) String

func (x *MakeHatArgsV1_SizeV1) 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 NewHaberdasherV1Server

func NewHaberdasherV1Server(svc HaberdasherV1, opts ...interface{}) TwirpServer

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