json_serialization

Documentation

Index

• Constants
• Variables
• func WriteError(resp http.ResponseWriter, err error)
• type HTTPClient
• type JSONSerialization
  • func NewJSONSerializationJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) JSONSerialization
  • func NewJSONSerializationProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) JSONSerialization
• type Msg
  • func (*Msg) Descriptor() ([]byte, []int)
  • func (x *Msg) GetAllEmpty() bool
  • func (x *Msg) GetFoobar() Msg_FooBar
  • func (x *Msg) GetHell() float64
  • func (x *Msg) GetPageNumber() int32
  • func (x *Msg) GetQuery() string
  • func (x *Msg) GetSnippets() []string
  • func (*Msg) ProtoMessage()
  • func (x *Msg) ProtoReflect() protoreflect.Message
  • func (x *Msg) Reset()
  • func (x *Msg) String() string
• type Msg_FooBar
  • func (Msg_FooBar) Descriptor() protoreflect.EnumDescriptor
  • func (x Msg_FooBar) Enum() *Msg_FooBar
  • func (Msg_FooBar) EnumDescriptor() ([]byte, []int)
  • func (x Msg_FooBar) Number() protoreflect.EnumNumber
  • func (x Msg_FooBar) String() string
  • func (Msg_FooBar) Type() protoreflect.EnumType
• type Result
  • func (*Result) Descriptor() ([]byte, []int)
  • func (*Result) ProtoMessage()
  • func (x *Result) ProtoReflect() protoreflect.Message
  • func (x *Result) Reset()
  • func (x *Result) String() string
• type TwirpServer
  • func NewJSONSerializationServer(svc JSONSerialization, opts ...interface{}) TwirpServer

Constants

const JSONSerializationPathPrefix = "/twirp/JSONSerialization/"

JSONSerializationPathPrefix 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 (
	Msg_FooBar_name = map[int32]string{
		0: "FOO",
		1: "BAR",
	}
	Msg_FooBar_value = map[string]int32{
		"FOO": 0,
		"BAR": 1,
	}
)

Enum value maps for Msg_FooBar.

var File_json_serialization_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 JSONSerialization

type JSONSerialization interface {
	EchoJSON(context.Context, *Msg) (*Msg, error)
}

func NewJSONSerializationJSONClient

func NewJSONSerializationJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) JSONSerialization

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

func NewJSONSerializationProtobufClient

func NewJSONSerializationProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) JSONSerialization

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

type Msg

type Msg struct {
	Query      string     `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	PageNumber int32      `protobuf:"varint,2,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
	Hell       float64    `protobuf:"fixed64,3,opt,name=hell,proto3" json:"hell,omitempty"`
	Foobar     Msg_FooBar `protobuf:"varint,4,opt,name=foobar,proto3,enum=Msg_FooBar" json:"foobar,omitempty"`
	Snippets   []string   `protobuf:"bytes,5,rep,name=snippets,proto3" json:"snippets,omitempty"`
	AllEmpty   bool       `protobuf:"varint,6,opt,name=all_empty,json=allEmpty,proto3" json:"all_empty,omitempty"`
	// contains filtered or unexported fields
}

func (*Msg) Descriptor

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

Deprecated: Use Msg.ProtoReflect.Descriptor instead.

func (*Msg) GetAllEmpty

func (x *Msg) GetAllEmpty() bool

func (*Msg) GetFoobar

func (x *Msg) GetFoobar() Msg_FooBar

func (*Msg) GetHell

func (x *Msg) GetHell() float64

func (*Msg) GetPageNumber

func (x *Msg) GetPageNumber() int32

func (*Msg) GetQuery

func (x *Msg) GetQuery() string

func (*Msg) GetSnippets

func (x *Msg) GetSnippets() []string

func (*Msg) ProtoMessage

func (*Msg) ProtoMessage()

func (*Msg) ProtoReflect

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

func (*Msg) Reset

func (x *Msg) Reset()

func (*Msg) String

func (x *Msg) String() string

type Msg_FooBar

type Msg_FooBar int32

const (
	Msg_FOO Msg_FooBar = 0
	Msg_BAR Msg_FooBar = 1
)

func (Msg_FooBar) Descriptor

func (Msg_FooBar) Descriptor() protoreflect.EnumDescriptor

func (Msg_FooBar) Enum

func (x Msg_FooBar) Enum() *Msg_FooBar

func (Msg_FooBar) EnumDescriptor

func (Msg_FooBar) EnumDescriptor() ([]byte, []int)

Deprecated: Use Msg_FooBar.Descriptor instead.

func (Msg_FooBar) Number

func (x Msg_FooBar) Number() protoreflect.EnumNumber

func (Msg_FooBar) String

func (x Msg_FooBar) String() string

func (Msg_FooBar) Type

func (Msg_FooBar) Type() protoreflect.EnumType

type Result

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

func (*Result) Descriptor

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

Deprecated: Use Result.ProtoReflect.Descriptor instead.

func (*Result) ProtoMessage

func (*Result) ProtoMessage()

func (*Result) ProtoReflect

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

func (*Result) Reset

func (x *Result) Reset()

func (*Result) String

func (x *Result) 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 NewJSONSerializationServer

func NewJSONSerializationServer(svc JSONSerialization, opts ...interface{}) TwirpServer

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