Documentation ¶
Overview ¶
Package no_package_name is a generated twirk stub package. This code was generated with github.com/darioielardi/twirk/protoc-gen-twirk v5.8.0.
It is generated from these files:
no_package_name.proto
Index ¶
- Constants
- func NewSvcServer(svc Svc, hooks *twirk.ServerHooks) twirkServer
- func WriteError(resp http.ResponseWriter, err error)
- type HTTPClient
- type Msg
- func (*Msg) Descriptor() ([]byte, []int)
- 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 Svc
Constants ¶
const SvcPathPrefix = "/twirk/Svc/"
SvcPathPrefix is used for all URL paths on a twirk Svc server. Requests are always: POST SvcPathPrefix/method It can be used in an HTTP mux to route twirk requests along with non-twirk requests on other routes.
Variables ¶
This section is empty.
Functions ¶
func NewSvcServer ¶
func NewSvcServer(svc Svc, hooks *twirk.ServerHooks) twirkServer
func WriteError ¶
func WriteError(resp http.ResponseWriter, err error)
WriteError writes an HTTP response with a valid twirk error format (code, msg, meta). Useful outside of the twirk server (e.g. http middleware), but does not trigger hooks. If err is not a twirk.Error, it will get wrapped with twirk.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 Msg ¶
type Msg struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*Msg) Descriptor ¶
func (*Msg) ProtoMessage ¶
func (*Msg) ProtoMessage()
func (*Msg) XXX_DiscardUnknown ¶
func (m *Msg) XXX_DiscardUnknown()
func (*Msg) XXX_Unmarshal ¶
type Svc ¶
func NewSvcJSONClient ¶
func NewSvcJSONClient(addr string, client HTTPClient) Svc
NewSvcJSONClient creates a JSON client that implements the Svc interface. It communicates using JSON and can be configured with a custom HTTPClient.
func NewSvcProtobufClient ¶
func NewSvcProtobufClient(addr string, client HTTPClient) Svc
NewSvcProtobufClient creates a Protobuf client that implements the Svc interface. It communicates using Protobuf and can be configured with a custom HTTPClient.