userconnect

package

v0.0.0-...-4a8f87e Latest Latest Go to latest Published: May 13, 2024 License: Apache-2.0 Imports: 6 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/rigdev/rig-go-api

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NewServiceHandler(svc ServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
type ServiceClient
- func NewServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ServiceClient
type ServiceHandler
type UnimplementedServiceHandler

Constants ¶

View Source

const (
	// ServiceCreateProcedure is the fully-qualified name of the Service's Create RPC.
	ServiceCreateProcedure = "/api.v1.user.Service/Create"
	// ServiceUpdateProcedure is the fully-qualified name of the Service's Update RPC.
	ServiceUpdateProcedure = "/api.v1.user.Service/Update"
	// ServiceListSessionsProcedure is the fully-qualified name of the Service's ListSessions RPC.
	ServiceListSessionsProcedure = "/api.v1.user.Service/ListSessions"
	// ServiceGetProcedure is the fully-qualified name of the Service's Get RPC.
	ServiceGetProcedure = "/api.v1.user.Service/Get"
	// ServiceGetByIdentifierProcedure is the fully-qualified name of the Service's GetByIdentifier RPC.
	ServiceGetByIdentifierProcedure = "/api.v1.user.Service/GetByIdentifier"
	// ServiceListProcedure is the fully-qualified name of the Service's List RPC.
	ServiceListProcedure = "/api.v1.user.Service/List"
	// ServiceDeleteProcedure is the fully-qualified name of the Service's Delete RPC.
	ServiceDeleteProcedure = "/api.v1.user.Service/Delete"
)

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.

View Source

const (
	// ServiceName is the fully-qualified name of the Service service.
	ServiceName = "api.v1.user.Service"
)

Variables ¶

This section is empty.

Functions ¶

func NewServiceHandler ¶

func NewServiceHandler(svc ServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewServiceHandler 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 ServiceClient ¶

type ServiceClient interface {
	// Create a new user.
	Create(context.Context, *connect.Request[user.CreateRequest]) (*connect.Response[user.CreateResponse], error)
	// Update a users profile and info.
	Update(context.Context, *connect.Request[user.UpdateRequest]) (*connect.Response[user.UpdateResponse], error)
	// Get the list of active sessions for the given user.
	ListSessions(context.Context, *connect.Request[user.ListSessionsRequest]) (*connect.Response[user.ListSessionsResponse], error)
	// Get a user by user-id.
	Get(context.Context, *connect.Request[user.GetRequest]) (*connect.Response[user.GetResponse], error)
	// Lookup a user by a unique identifier - email, username, phone number etc.
	GetByIdentifier(context.Context, *connect.Request[user.GetByIdentifierRequest]) (*connect.Response[user.GetByIdentifierResponse], error)
	// List users.
	List(context.Context, *connect.Request[user.ListRequest]) (*connect.Response[user.ListResponse], error)
	// Delete a specific user.
	Delete(context.Context, *connect.Request[user.DeleteRequest]) (*connect.Response[user.DeleteResponse], error)
}

ServiceClient is a client for the api.v1.user.Service service.

func NewServiceClient ¶

func NewServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ServiceClient

NewServiceClient constructs a client for the api.v1.user.Service 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 ServiceHandler ¶

type ServiceHandler interface {
	// Create a new user.
	Create(context.Context, *connect.Request[user.CreateRequest]) (*connect.Response[user.CreateResponse], error)
	// Update a users profile and info.
	Update(context.Context, *connect.Request[user.UpdateRequest]) (*connect.Response[user.UpdateResponse], error)
	// Get the list of active sessions for the given user.
	ListSessions(context.Context, *connect.Request[user.ListSessionsRequest]) (*connect.Response[user.ListSessionsResponse], error)
	// Get a user by user-id.
	Get(context.Context, *connect.Request[user.GetRequest]) (*connect.Response[user.GetResponse], error)
	// Lookup a user by a unique identifier - email, username, phone number etc.
	GetByIdentifier(context.Context, *connect.Request[user.GetByIdentifierRequest]) (*connect.Response[user.GetByIdentifierResponse], error)
	// List users.
	List(context.Context, *connect.Request[user.ListRequest]) (*connect.Response[user.ListResponse], error)
	// Delete a specific user.
	Delete(context.Context, *connect.Request[user.DeleteRequest]) (*connect.Response[user.DeleteResponse], error)
}

ServiceHandler is an implementation of the api.v1.user.Service service.

type UnimplementedServiceHandler ¶

type UnimplementedServiceHandler struct{}

UnimplementedServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedServiceHandler) Create ¶

func (UnimplementedServiceHandler) Create(context.Context, *connect.Request[user.CreateRequest]) (*connect.Response[user.CreateResponse], error)

func (UnimplementedServiceHandler) Delete ¶

func (UnimplementedServiceHandler) Delete(context.Context, *connect.Request[user.DeleteRequest]) (*connect.Response[user.DeleteResponse], error)

func (UnimplementedServiceHandler) Get ¶

func (UnimplementedServiceHandler) Get(context.Context, *connect.Request[user.GetRequest]) (*connect.Response[user.GetResponse], error)

func (UnimplementedServiceHandler) GetByIdentifier ¶

func (UnimplementedServiceHandler) GetByIdentifier(context.Context, *connect.Request[user.GetByIdentifierRequest]) (*connect.Response[user.GetByIdentifierResponse], error)

func (UnimplementedServiceHandler) List ¶

func (UnimplementedServiceHandler) List(context.Context, *connect.Request[user.ListRequest]) (*connect.Response[user.ListResponse], error)

func (UnimplementedServiceHandler) ListSessions ¶

func (UnimplementedServiceHandler) ListSessions(context.Context, *connect.Request[user.ListSessionsRequest]) (*connect.Response[user.ListSessionsResponse], error)

func (UnimplementedServiceHandler) Update ¶

func (UnimplementedServiceHandler) Update(context.Context, *connect.Request[user.UpdateRequest]) (*connect.Response[user.UpdateResponse], error)

Source Files ¶

View all Source files

service.connect.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL