Documentation
¶
Overview ¶
Package json_serialization is a generated twirp stub package. This code was generated with github.com/twitchtv/twirp/protoc-gen-twirp v7.2.0.
It is generated from these files:
json_serialization.proto
Index ¶
- Constants
- Variables
- func WriteError(resp http.ResponseWriter, err error)
- type HTTPClient
- type JSONSerialization
- type Msg
- func (*Msg) Descriptor() ([]byte, []int)
- func (m *Msg) GetAllEmpty() bool
- func (m *Msg) GetFoobar() Msg_FooBar
- func (m *Msg) GetHell() float64
- func (m *Msg) GetPageNumber() int32
- func (m *Msg) GetQuery() string
- func (m *Msg) GetSnippets() []string
- func (*Msg) ProtoMessage()
- func (m *Msg) Reset()
- func (m *Msg) String() string
- func (m *Msg) XXX_DiscardUnknown()
- func (m *Msg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Msg) XXX_Merge(src proto.Message)
- func (m *Msg) XXX_Size() int
- func (m *Msg) XXX_Unmarshal(b []byte) error
- type Msg_FooBar
- type Result
- func (*Result) Descriptor() ([]byte, []int)
- func (*Result) ProtoMessage()
- func (m *Result) Reset()
- func (m *Result) String() string
- func (m *Result) XXX_DiscardUnknown()
- func (m *Result) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Result) XXX_Merge(src proto.Message)
- func (m *Result) XXX_Size() int
- func (m *Result) XXX_Unmarshal(b []byte) error
- type TwirpServer
Constants ¶
const JSONSerializationPathPrefix = "/twirp/JSONSerialization/"
JSONSerializationPathPrefix 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
Variables ¶
var Msg_FooBar_name = map[int32]string{
0: "FOO",
1: "BAR",
}
var Msg_FooBar_value = map[string]int32{
"FOO": 0,
"BAR": 1,
}
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 ¶
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 ¶
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"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (*Msg) Descriptor ¶
func (*Msg) GetAllEmpty ¶
func (*Msg) GetFoobar ¶
func (m *Msg) GetFoobar() Msg_FooBar
func (*Msg) GetPageNumber ¶
func (*Msg) GetSnippets ¶
func (*Msg) ProtoMessage ¶
func (*Msg) ProtoMessage()
func (*Msg) XXX_DiscardUnknown ¶
func (m *Msg) XXX_DiscardUnknown()
func (*Msg) XXX_Unmarshal ¶
type Msg_FooBar ¶
type Msg_FooBar int32
const ( Msg_FOO Msg_FooBar = 0 Msg_BAR Msg_FooBar = 1 )
func (Msg_FooBar) EnumDescriptor ¶
func (Msg_FooBar) EnumDescriptor() ([]byte, []int)
func (Msg_FooBar) String ¶
func (x Msg_FooBar) String() string
type Result ¶
type Result struct {
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
func (*Result) Descriptor ¶
func (*Result) ProtoMessage ¶
func (*Result) ProtoMessage()
func (*Result) XXX_DiscardUnknown ¶
func (m *Result) XXX_DiscardUnknown()
func (*Result) XXX_Marshal ¶
func (*Result) XXX_Unmarshal ¶
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 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).
Source Files