v1pluginrpc

Documentation

Index

• Constants
• func RegisterCheckServiceServer(serverRegistrar pluginrpc.ServerRegistrar, ...)
• type CheckServiceClient
  • func NewCheckServiceClient(client pluginrpc.Client) (CheckServiceClient, error)
• type CheckServiceHandler
• type CheckServiceServer
  • func NewCheckServiceServer(handler pluginrpc.Handler, checkServiceHandler CheckServiceHandler) CheckServiceServer
• type CheckServiceSpecBuilder
  • func (s CheckServiceSpecBuilder) Build() (pluginrpc.Spec, error)

Constants

const (
	// CheckServiceCheckPath is the path of the CheckService's Check RPC.
	CheckServiceCheckPath = "/buf.plugin.check.v1.CheckService/Check"
	// CheckServiceListRulesPath is the path of the CheckService's ListRules RPC.
	CheckServiceListRulesPath = "/buf.plugin.check.v1.CheckService/ListRules"
	// CheckServiceListCategoriesPath is the path of the CheckService's ListCategories RPC.
	CheckServiceListCategoriesPath = "/buf.plugin.check.v1.CheckService/ListCategories"
)

Functions

func RegisterCheckServiceServer

func RegisterCheckServiceServer(serverRegistrar pluginrpc.ServerRegistrar, checkServiceServer CheckServiceServer)

RegisterCheckServiceServer registers the server for the buf.plugin.check.v1.CheckService service.

Types

type CheckServiceClient

type CheckServiceClient interface {
	// Check a set of FileDescriptors for failures.
	//
	// All Annotations returned will have an ID that is contained within a Rule listed by ListRules.
	Check(context.Context, *v1.CheckRequest, ...pluginrpc.CallOption) (*v1.CheckResponse, error)
	// List all rules that this service implements.
	ListRules(context.Context, *v1.ListRulesRequest, ...pluginrpc.CallOption) (*v1.ListRulesResponse, error)
	// List all categories that this service implements.
	ListCategories(context.Context, *v1.ListCategoriesRequest, ...pluginrpc.CallOption) (*v1.ListCategoriesResponse, error)
}

CheckServiceClient is a client for the buf.plugin.check.v1.CheckService service.

func NewCheckServiceClient

func NewCheckServiceClient(client pluginrpc.Client) (CheckServiceClient, error)

NewCheckServiceClient constructs a client for the buf.plugin.check.v1.CheckService service.

type CheckServiceHandler

type CheckServiceHandler interface {
	// Check a set of FileDescriptors for failures.
	//
	// All Annotations returned will have an ID that is contained within a Rule listed by ListRules.
	Check(context.Context, *v1.CheckRequest) (*v1.CheckResponse, error)
	// List all rules that this service implements.
	ListRules(context.Context, *v1.ListRulesRequest) (*v1.ListRulesResponse, error)
	// List all categories that this service implements.
	ListCategories(context.Context, *v1.ListCategoriesRequest) (*v1.ListCategoriesResponse, error)
}

CheckServiceHandler is an implementation of the buf.plugin.check.v1.CheckService service.

type CheckServiceServer

type CheckServiceServer interface {
	// Check a set of FileDescriptors for failures.
	//
	// All Annotations returned will have an ID that is contained within a Rule listed by ListRules.
	Check(context.Context, pluginrpc.HandleEnv, ...pluginrpc.HandleOption) error
	// List all rules that this service implements.
	ListRules(context.Context, pluginrpc.HandleEnv, ...pluginrpc.HandleOption) error
	// List all categories that this service implements.
	ListCategories(context.Context, pluginrpc.HandleEnv, ...pluginrpc.HandleOption) error
}

CheckServiceServer serves the buf.plugin.check.v1.CheckService service.

func NewCheckServiceServer

func NewCheckServiceServer(handler pluginrpc.Handler, checkServiceHandler CheckServiceHandler) CheckServiceServer

NewCheckServiceServer constructs a server for the buf.plugin.check.v1.CheckService service.

type CheckServiceSpecBuilder

type CheckServiceSpecBuilder struct {
	Check          []pluginrpc.ProcedureOption
	ListRules      []pluginrpc.ProcedureOption
	ListCategories []pluginrpc.ProcedureOption
}

CheckServiceSpecBuilder builds a Spec for the buf.plugin.check.v1.CheckService service.

func (CheckServiceSpecBuilder) Build

func (s CheckServiceSpecBuilder) Build() (pluginrpc.Spec, error)

Build builds a Spec for the buf.plugin.check.v1.CheckService service.