checkv1grpc

Documentation

Index

• Constants
• Variables
• func RegisterCheckServiceServer(s grpc.ServiceRegistrar, srv CheckServiceServer)
• type CheckServiceClient
  • func NewCheckServiceClient(cc grpc.ClientConnInterface) CheckServiceClient
• type CheckServiceServer
• type UnimplementedCheckServiceServer
  • func (UnimplementedCheckServiceServer) Check(context.Context, *v1.CheckRequest) (*v1.CheckResponse, error)
  • func (UnimplementedCheckServiceServer) ListCategories(context.Context, *v1.ListCategoriesRequest) (*v1.ListCategoriesResponse, error)
  • func (UnimplementedCheckServiceServer) ListRules(context.Context, *v1.ListRulesRequest) (*v1.ListRulesResponse, error)
• type UnsafeCheckServiceServer

Constants

const (
	CheckService_Check_FullMethodName          = "/buf.plugin.check.v1.CheckService/Check"
	CheckService_ListRules_FullMethodName      = "/buf.plugin.check.v1.CheckService/ListRules"
	CheckService_ListCategories_FullMethodName = "/buf.plugin.check.v1.CheckService/ListCategories"
)

Variables

var CheckService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "buf.plugin.check.v1.CheckService",
	HandlerType: (*CheckServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Check",
			Handler:    _CheckService_Check_Handler,
		},
		{
			MethodName: "ListRules",
			Handler:    _CheckService_ListRules_Handler,
		},
		{
			MethodName: "ListCategories",
			Handler:    _CheckService_ListCategories_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "buf/plugin/check/v1/check_service.proto",
}

CheckService_ServiceDesc is the grpc.ServiceDesc for CheckService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterCheckServiceServer

func RegisterCheckServiceServer(s grpc.ServiceRegistrar, srv CheckServiceServer)

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(ctx context.Context, in *v1.CheckRequest, opts ...grpc.CallOption) (*v1.CheckResponse, error)
	// List all rules that this service implements.
	ListRules(ctx context.Context, in *v1.ListRulesRequest, opts ...grpc.CallOption) (*v1.ListRulesResponse, error)
	// List all categories that this service implements.
	ListCategories(ctx context.Context, in *v1.ListCategoriesRequest, opts ...grpc.CallOption) (*v1.ListCategoriesResponse, error)
}

CheckServiceClient is the client API for CheckService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

The service that defines check operations.

A check is a lint or breaking change check. The only difference between lint and breaking change checks from an API standpoint is that breaking change checks also need FileDescriptors to check against. As such, instead of duplicating the API into two separate services, we combine all checks into a single interface for simplicity of plugin author implementation.

func NewCheckServiceClient

func NewCheckServiceClient(cc grpc.ClientConnInterface) CheckServiceClient

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, *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)
}

CheckServiceServer is the server API for CheckService service. All implementations should embed UnimplementedCheckServiceServer for forward compatibility.

The service that defines check operations.

A check is a lint or breaking change check. The only difference between lint and breaking change checks from an API standpoint is that breaking change checks also need FileDescriptors to check against. As such, instead of duplicating the API into two separate services, we combine all checks into a single interface for simplicity of plugin author implementation.

type UnimplementedCheckServiceServer

type UnimplementedCheckServiceServer struct{}

UnimplementedCheckServiceServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedCheckServiceServer) Check

func (UnimplementedCheckServiceServer) Check(context.Context, *v1.CheckRequest) (*v1.CheckResponse, error)

func (UnimplementedCheckServiceServer) ListCategories

func (UnimplementedCheckServiceServer) ListCategories(context.Context, *v1.ListCategoriesRequest) (*v1.ListCategoriesResponse, error)

func (UnimplementedCheckServiceServer) ListRules

func (UnimplementedCheckServiceServer) ListRules(context.Context, *v1.ListRulesRequest) (*v1.ListRulesResponse, error)

type UnsafeCheckServiceServer

type UnsafeCheckServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeCheckServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CheckServiceServer will result in compilation errors.