twirp: Index | Files

package importable

import ""

Package importable is a generated twirp stub package. This code was generated with v5.12.0.

Test to make sure that importing other packages doesnt break

It is generated from these files:



Package Files

gen.go importable.pb.go importable.twirp.go


const SvcPathPrefix = "/twirp/twirp.internal.twirptest.importable.Svc/"

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

func WriteError Uses

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)

type HTTPClient Uses

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 Msg Uses

type Msg struct {
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`

func (*Msg) Descriptor Uses

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

func (*Msg) ProtoMessage Uses

func (*Msg) ProtoMessage()

func (*Msg) Reset Uses

func (m *Msg) Reset()

func (*Msg) String Uses

func (m *Msg) String() string

func (*Msg) XXX_DiscardUnknown Uses

func (m *Msg) XXX_DiscardUnknown()

func (*Msg) XXX_Marshal Uses

func (m *Msg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Msg) XXX_Merge Uses

func (m *Msg) XXX_Merge(src proto.Message)

func (*Msg) XXX_Size Uses

func (m *Msg) XXX_Size() int

func (*Msg) XXX_Unmarshal Uses

func (m *Msg) XXX_Unmarshal(b []byte) error

type Svc Uses

type Svc interface {
    Send(context.Context, *Msg) (*Msg, error)

func NewSvcJSONClient Uses

func NewSvcJSONClient(addr string, client HTTPClient, opts ...twirp.ClientOption) 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 Uses

func NewSvcProtobufClient(addr string, client HTTPClient, opts ...twirp.ClientOption) Svc

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

type TwirpServer Uses

type TwirpServer interface {
    // ServiceDescriptor returns gzipped bytes describing the .proto file that
    // this service was generated from. Once unzipped, the bytes can be
    // unmarshalled as a
    // 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
    // alongside non-twirp requests on one HTTP listener.
    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 NewSvcServer Uses

func NewSvcServer(svc Svc, hooks *twirp.ServerHooks) TwirpServer

Package importable imports 15 packages (graph) and is imported by 3 packages. Updated 2020-07-07. Refresh now. Tools for package owners.