Documentation
¶
Index ¶
- Constants
- func NewVCSServiceHandler(svc VCSServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- func RegisterVCSServiceHandler(mux *mux.Router, svc VCSServiceHandler, opts ...connect.HandlerOption)
- type UnimplementedVCSServiceHandler
- func (UnimplementedVCSServiceHandler) GetCommit(context.Context, *connect.Request[v1.GetCommitRequest]) (*connect.Response[v1.GetCommitResponse], error)
- func (UnimplementedVCSServiceHandler) GetCommits(context.Context, *connect.Request[v1.GetCommitsRequest]) (*connect.Response[v1.GetCommitsResponse], error)
- func (UnimplementedVCSServiceHandler) GetFile(context.Context, *connect.Request[v1.GetFileRequest]) (*connect.Response[v1.GetFileResponse], error)
- func (UnimplementedVCSServiceHandler) GithubApp(context.Context, *connect.Request[v1.GithubAppRequest]) (*connect.Response[v1.GithubAppResponse], error)
- func (UnimplementedVCSServiceHandler) GithubLogin(context.Context, *connect.Request[v1.GithubLoginRequest]) (*connect.Response[v1.GithubLoginResponse], error)
- func (UnimplementedVCSServiceHandler) GithubRefresh(context.Context, *connect.Request[v1.GithubRefreshRequest]) (*connect.Response[v1.GithubRefreshResponse], error)
- type VCSServiceClient
- type VCSServiceHandler
Constants ¶
const ( // VCSServiceGithubAppProcedure is the fully-qualified name of the VCSService's GithubApp RPC. VCSServiceGithubAppProcedure = "/vcs.v1.VCSService/GithubApp" // VCSServiceGithubLoginProcedure is the fully-qualified name of the VCSService's GithubLogin RPC. VCSServiceGithubLoginProcedure = "/vcs.v1.VCSService/GithubLogin" // VCSServiceGithubRefreshProcedure is the fully-qualified name of the VCSService's GithubRefresh // RPC. VCSServiceGithubRefreshProcedure = "/vcs.v1.VCSService/GithubRefresh" // VCSServiceGetFileProcedure is the fully-qualified name of the VCSService's GetFile RPC. VCSServiceGetFileProcedure = "/vcs.v1.VCSService/GetFile" // VCSServiceGetCommitProcedure is the fully-qualified name of the VCSService's GetCommit RPC. VCSServiceGetCommitProcedure = "/vcs.v1.VCSService/GetCommit" // VCSServiceGetCommitsProcedure is the fully-qualified name of the VCSService's GetCommits RPC. VCSServiceGetCommitsProcedure = "/vcs.v1.VCSService/GetCommits" )
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 (
// VCSServiceName is the fully-qualified name of the VCSService service.
VCSServiceName = "vcs.v1.VCSService"
)
Variables ¶
This section is empty.
Functions ¶
func NewVCSServiceHandler ¶
func NewVCSServiceHandler(svc VCSServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewVCSServiceHandler 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.
func RegisterVCSServiceHandler ¶
func RegisterVCSServiceHandler(mux *mux.Router, svc VCSServiceHandler, opts ...connect.HandlerOption)
RegisterVCSServiceHandler register an HTTP handler to a mux.Router from the service implementation.
Types ¶
type UnimplementedVCSServiceHandler ¶
type UnimplementedVCSServiceHandler struct{}
UnimplementedVCSServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedVCSServiceHandler) GetCommit ¶
func (UnimplementedVCSServiceHandler) GetCommit(context.Context, *connect.Request[v1.GetCommitRequest]) (*connect.Response[v1.GetCommitResponse], error)
func (UnimplementedVCSServiceHandler) GetCommits ¶
func (UnimplementedVCSServiceHandler) GetCommits(context.Context, *connect.Request[v1.GetCommitsRequest]) (*connect.Response[v1.GetCommitsResponse], error)
func (UnimplementedVCSServiceHandler) GetFile ¶
func (UnimplementedVCSServiceHandler) GetFile(context.Context, *connect.Request[v1.GetFileRequest]) (*connect.Response[v1.GetFileResponse], error)
func (UnimplementedVCSServiceHandler) GithubApp ¶
func (UnimplementedVCSServiceHandler) GithubApp(context.Context, *connect.Request[v1.GithubAppRequest]) (*connect.Response[v1.GithubAppResponse], error)
func (UnimplementedVCSServiceHandler) GithubLogin ¶
func (UnimplementedVCSServiceHandler) GithubLogin(context.Context, *connect.Request[v1.GithubLoginRequest]) (*connect.Response[v1.GithubLoginResponse], error)
func (UnimplementedVCSServiceHandler) GithubRefresh ¶
func (UnimplementedVCSServiceHandler) GithubRefresh(context.Context, *connect.Request[v1.GithubRefreshRequest]) (*connect.Response[v1.GithubRefreshResponse], error)
type VCSServiceClient ¶
type VCSServiceClient interface {
GithubApp(context.Context, *connect.Request[v1.GithubAppRequest]) (*connect.Response[v1.GithubAppResponse], error)
GithubLogin(context.Context, *connect.Request[v1.GithubLoginRequest]) (*connect.Response[v1.GithubLoginResponse], error)
GithubRefresh(context.Context, *connect.Request[v1.GithubRefreshRequest]) (*connect.Response[v1.GithubRefreshResponse], error)
GetFile(context.Context, *connect.Request[v1.GetFileRequest]) (*connect.Response[v1.GetFileResponse], error)
GetCommit(context.Context, *connect.Request[v1.GetCommitRequest]) (*connect.Response[v1.GetCommitResponse], error)
GetCommits(context.Context, *connect.Request[v1.GetCommitsRequest]) (*connect.Response[v1.GetCommitsResponse], error)
}
VCSServiceClient is a client for the vcs.v1.VCSService service.
func NewVCSServiceClient ¶
func NewVCSServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) VCSServiceClient
NewVCSServiceClient constructs a client for the vcs.v1.VCSService 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 VCSServiceHandler ¶
type VCSServiceHandler interface {
GithubApp(context.Context, *connect.Request[v1.GithubAppRequest]) (*connect.Response[v1.GithubAppResponse], error)
GithubLogin(context.Context, *connect.Request[v1.GithubLoginRequest]) (*connect.Response[v1.GithubLoginResponse], error)
GithubRefresh(context.Context, *connect.Request[v1.GithubRefreshRequest]) (*connect.Response[v1.GithubRefreshResponse], error)
GetFile(context.Context, *connect.Request[v1.GetFileRequest]) (*connect.Response[v1.GetFileResponse], error)
GetCommit(context.Context, *connect.Request[v1.GetCommitRequest]) (*connect.Response[v1.GetCommitResponse], error)
GetCommits(context.Context, *connect.Request[v1.GetCommitsRequest]) (*connect.Response[v1.GetCommitsResponse], error)
}
VCSServiceHandler is an implementation of the vcs.v1.VCSService service.
Source Files