Documentation
¶
Index ¶
- Constants
- func NewCheckServiceHandler(svc CheckServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type CheckServiceClient
- type CheckServiceHandler
- type UnimplementedCheckServiceHandler
- func (UnimplementedCheckServiceHandler) Check(context.Context, *v1.CheckRequest) (*v1.CheckResponse, error)
- func (UnimplementedCheckServiceHandler) ListCategories(context.Context, *v1.ListCategoriesRequest) (*v1.ListCategoriesResponse, error)
- func (UnimplementedCheckServiceHandler) ListRules(context.Context, *v1.ListRulesRequest) (*v1.ListRulesResponse, error)
Constants ¶
const ( // CheckServiceCheckProcedure is the fully-qualified name of the CheckService's Check RPC. CheckServiceCheckProcedure = "/buf.plugin.check.v1.CheckService/Check" // CheckServiceListRulesProcedure is the fully-qualified name of the CheckService's ListRules RPC. CheckServiceListRulesProcedure = "/buf.plugin.check.v1.CheckService/ListRules" // CheckServiceListCategoriesProcedure is the fully-qualified name of the CheckService's // ListCategories RPC. CheckServiceListCategoriesProcedure = "/buf.plugin.check.v1.CheckService/ListCategories" )
These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.
Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.
const (
// CheckServiceName is the fully-qualified name of the CheckService service.
CheckServiceName = "buf.plugin.check.v1.CheckService"
)
Variables ¶
This section is empty.
Functions ¶
func NewCheckServiceHandler ¶
func NewCheckServiceHandler(svc CheckServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewCheckServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.
By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.
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) (*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)
}
CheckServiceClient is a client for the buf.plugin.check.v1.CheckService service.
func NewCheckServiceClient ¶
func NewCheckServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) CheckServiceClient
NewCheckServiceClient constructs a client for the buf.plugin.check.v1.CheckService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.
The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).
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 UnimplementedCheckServiceHandler ¶
type UnimplementedCheckServiceHandler struct{}
UnimplementedCheckServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedCheckServiceHandler) Check ¶
func (UnimplementedCheckServiceHandler) Check(context.Context, *v1.CheckRequest) (*v1.CheckResponse, error)
func (UnimplementedCheckServiceHandler) ListCategories ¶
func (UnimplementedCheckServiceHandler) ListCategories(context.Context, *v1.ListCategoriesRequest) (*v1.ListCategoriesResponse, error)
func (UnimplementedCheckServiceHandler) ListRules ¶
func (UnimplementedCheckServiceHandler) ListRules(context.Context, *v1.ListRulesRequest) (*v1.ListRulesResponse, error)
Source Files
¶
- check_service.connect.go