proto

package
v0.0.0-...-4ec33cd Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 19, 2022 License: MIT Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const TodoServicePathPrefix = "/twirp/bakins.todo.v1.TodoService/"

TodoServicePathPrefix 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

View Source 
var File_proto_todo_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 CreateTaskRequest 

type CreateTaskRequest struct {
	Title       string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTaskRequest) Descriptor deprecated 

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

Deprecated: Use CreateTaskRequest.ProtoReflect.Descriptor instead.

func (*CreateTaskRequest) GetDescription 

func (x *CreateTaskRequest) GetDescription() string

func (*CreateTaskRequest) GetTitle 

func (x *CreateTaskRequest) GetTitle() string

func (*CreateTaskRequest) ProtoMessage 

func (*CreateTaskRequest) ProtoMessage()

func (*CreateTaskRequest) ProtoReflect 

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

func (*CreateTaskRequest) Reset 

func (x *CreateTaskRequest) Reset()

func (*CreateTaskRequest) String 

func (x *CreateTaskRequest) String() string

type CreateTaskResponse 

type CreateTaskResponse struct {
	Task *Task `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTaskResponse) Descriptor deprecated 

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

Deprecated: Use CreateTaskResponse.ProtoReflect.Descriptor instead.

func (*CreateTaskResponse) GetTask 

func (x *CreateTaskResponse) GetTask() *Task

func (*CreateTaskResponse) ProtoMessage 

func (*CreateTaskResponse) ProtoMessage()

func (*CreateTaskResponse) ProtoReflect 

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

func (*CreateTaskResponse) Reset 

func (x *CreateTaskResponse) Reset()

func (*CreateTaskResponse) String 

func (x *CreateTaskResponse) String() string

type GetTaskRequest 

type GetTaskRequest struct {
	Id uint64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTaskRequest) Descriptor deprecated 

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

Deprecated: Use GetTaskRequest.ProtoReflect.Descriptor instead.

func (*GetTaskRequest) GetId 

func (x *GetTaskRequest) GetId() uint64

func (*GetTaskRequest) ProtoMessage 

func (*GetTaskRequest) ProtoMessage()

func (*GetTaskRequest) ProtoReflect 

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

func (*GetTaskRequest) Reset 

func (x *GetTaskRequest) Reset()

func (*GetTaskRequest) String 

func (x *GetTaskRequest) String() string

type GetTaskResponse 

type GetTaskResponse struct {
	Task *Task `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTaskResponse) Descriptor deprecated 

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

Deprecated: Use GetTaskResponse.ProtoReflect.Descriptor instead.

func (*GetTaskResponse) GetTask 

func (x *GetTaskResponse) GetTask() *Task

func (*GetTaskResponse) ProtoMessage 

func (*GetTaskResponse) ProtoMessage()

func (*GetTaskResponse) ProtoReflect 

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

func (*GetTaskResponse) Reset 

func (x *GetTaskResponse) Reset()

func (*GetTaskResponse) String 

func (x *GetTaskResponse) String() string

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 ListTasksRequest 

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

func (*ListTasksRequest) Descriptor deprecated 

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

Deprecated: Use ListTasksRequest.ProtoReflect.Descriptor instead.

func (*ListTasksRequest) ProtoMessage 

func (*ListTasksRequest) ProtoMessage()

func (*ListTasksRequest) ProtoReflect 

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

func (*ListTasksRequest) Reset 

func (x *ListTasksRequest) Reset()

func (*ListTasksRequest) String 

func (x *ListTasksRequest) String() string

type ListTasksResponse 

type ListTasksResponse struct {
	Tasks []*Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// contains filtered or unexported fields
}

func (*ListTasksResponse) Descriptor deprecated 

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

Deprecated: Use ListTasksResponse.ProtoReflect.Descriptor instead.

func (*ListTasksResponse) GetTasks 

func (x *ListTasksResponse) GetTasks() []*Task

func (*ListTasksResponse) ProtoMessage 

func (*ListTasksResponse) ProtoMessage()

func (*ListTasksResponse) ProtoReflect 

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

func (*ListTasksResponse) Reset 

func (x *ListTasksResponse) Reset()

func (*ListTasksResponse) String 

func (x *ListTasksResponse) String() string

type Task 

type Task struct {
	Id          uint64                 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Created     *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=created,proto3" json:"created,omitempty"`
	Title       string                 `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
	Description string                 `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*Task) Descriptor deprecated 

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

Deprecated: Use Task.ProtoReflect.Descriptor instead.

func (*Task) GetCreated 

func (x *Task) GetCreated() *timestamppb.Timestamp

func (*Task) GetDescription 

func (x *Task) GetDescription() string

func (*Task) GetId 

func (x *Task) GetId() uint64

func (*Task) GetTitle 

func (x *Task) GetTitle() string

func (*Task) ProtoMessage 

func (*Task) ProtoMessage()

func (*Task) ProtoReflect 

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

func (*Task) Reset 

func (x *Task) Reset()

func (*Task) String 

func (x *Task) String() string

type TodoService 

type TodoService interface {
	ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)

	CreateTask(context.Context, *CreateTaskRequest) (*CreateTaskResponse, error)

	GetTask(context.Context, *GetTaskRequest) (*GetTaskResponse, error)
}

func NewTodoServiceJSONClient 

func NewTodoServiceJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) TodoService

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

func NewTodoServiceProtobufClient 

func NewTodoServiceProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) TodoService

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

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 NewTodoServiceServer 

func NewTodoServiceServer(svc TodoService, opts ...interface{}) TwirpServer

NewTodoServiceServer 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

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.