clipb

Documentation

Overview

Package clipb is a generated twirp stub package. This code was generated with github.com/twitchtv/twirp/protoc-gen-twirp v7.1.0.

It is generated from these files:

api.proto

Index

• Constants
• Variables
• func WriteError(resp http.ResponseWriter, err error)
• type API
  • func NewAPIJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) API
  • func NewAPIProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) API
• type HTTPClient
• type ProxyRequest
  • func (*ProxyRequest) Descriptor() ([]byte, []int)
  • func (x *ProxyRequest) GetProxyToken() string
  • func (*ProxyRequest) ProtoMessage()
  • func (x *ProxyRequest) ProtoReflect() protoreflect.Message
  • func (x *ProxyRequest) Reset()
  • func (x *ProxyRequest) String() string
• type ProxyResponse
  • func (*ProxyResponse) Descriptor() ([]byte, []int)
  • func (x *ProxyResponse) GetPrivatePaths() []string
  • func (x *ProxyResponse) GetURL() string
  • func (*ProxyResponse) ProtoMessage()
  • func (x *ProxyResponse) ProtoReflect() protoreflect.Message
  • func (x *ProxyResponse) Reset()
  • func (x *ProxyResponse) String() string
• type TwirpServer
  • func NewAPIServer(svc API, opts ...interface{}) TwirpServer

Constants

const APIPathPrefix = "/twirp/clipb.API/"

APIPathPrefix 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 File_api_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 API

type API interface {
	Proxy(context.Context, *ProxyRequest) (*ProxyResponse, error)
}

func NewAPIJSONClient

func NewAPIJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) API

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

func NewAPIProtobufClient

func NewAPIProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) API

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

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 ProxyRequest

type ProxyRequest struct {
	ProxyToken string `protobuf:"bytes,1,opt,name=proxyToken,proto3" json:"proxyToken,omitempty"`
	// contains filtered or unexported fields
}

func (*ProxyRequest) Descriptor

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

Deprecated: Use ProxyRequest.ProtoReflect.Descriptor instead.

func (*ProxyRequest) GetProxyToken

func (x *ProxyRequest) GetProxyToken() string

func (*ProxyRequest) ProtoMessage

func (*ProxyRequest) ProtoMessage()

func (*ProxyRequest) ProtoReflect

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

func (*ProxyRequest) Reset

func (x *ProxyRequest) Reset()

func (*ProxyRequest) String

func (x *ProxyRequest) String() string

type ProxyResponse

type ProxyResponse struct {
	URL          string   `protobuf:"bytes,1,opt,name=URL,proto3" json:"URL,omitempty"`
	PrivatePaths []string `protobuf:"bytes,2,rep,name=privatePaths,proto3" json:"privatePaths,omitempty"`
	// contains filtered or unexported fields
}

func (*ProxyResponse) Descriptor

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

Deprecated: Use ProxyResponse.ProtoReflect.Descriptor instead.

func (*ProxyResponse) GetPrivatePaths

func (x *ProxyResponse) GetPrivatePaths() []string

func (*ProxyResponse) GetURL

func (x *ProxyResponse) GetURL() string

func (*ProxyResponse) ProtoMessage

func (*ProxyResponse) ProtoMessage()

func (*ProxyResponse) ProtoReflect

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

func (*ProxyResponse) Reset

func (x *ProxyResponse) Reset()

func (*ProxyResponse) String

func (x *ProxyResponse) 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
	// 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 NewAPIServer

func NewAPIServer(svc API, opts ...interface{}) TwirpServer

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