id

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 11, 2023 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Id_Generate_FullMethodName = "/id.Id/Generate"
	Id_Types_FullMethodName    = "/id.Id/Types"
)

Variables

View Source 
var (
	Types_name = map[int32]string{
		0: "UUID",
		1: "NANOID",
		2: "ULID",
		3: "KSUID",
		4: "XID",
		5: "SNOWFLAKE",
		6: "BIGFLAKE",
		7: "SHORTID",
	}
	Types_value = map[string]int32{
		"UUID":      0,
		"NANOID":    1,
		"ULID":      2,
		"KSUID":     3,
		"XID":       4,
		"SNOWFLAKE": 5,
		"BIGFLAKE":  6,
		"SHORTID":   7,
	}
)

Enum value maps for Types.

View Source 
var File_id_id_proto protoreflect.FileDescriptor
View Source 
var Id_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "id.Id",
	HandlerType: (*IdServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Generate",
			Handler:    _Id_Generate_Handler,
		},
		{
			MethodName: "Types",
			Handler:    _Id_Types_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "id/id.proto",
}

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

Functions

func NewIdEndpoints 

func NewIdEndpoints() []*api.Endpoint

func RegisterIdHandler 

func RegisterIdHandler(s server.Server, hdlr IdHandler, opts ...server.HandlerOption) error

func RegisterIdServer 

func RegisterIdServer(s grpc.ServiceRegistrar, srv IdServer)

Types

type GenerateRequest 

type GenerateRequest struct {

	// type of id; call 'Types' endpoint for available types
	Type Types `protobuf:"varint,1,opt,name=type,proto3,enum=id.Types" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Generate a unique ID. Defaults to uuid.

func (*GenerateRequest) Descriptor deprecated 

func (*GenerateRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateRequest.ProtoReflect.Descriptor instead.

func (*GenerateRequest) GetType 

func (x *GenerateRequest) GetType() Types

func (*GenerateRequest) ProtoMessage 

func (*GenerateRequest) ProtoMessage()

func (*GenerateRequest) ProtoReflect 

func (x *GenerateRequest) ProtoReflect() protoreflect.Message

func (*GenerateRequest) Reset 

func (x *GenerateRequest) Reset()

func (*GenerateRequest) String 

func (x *GenerateRequest) String() string

type GenerateResponse 

type GenerateResponse struct {

	// the unique id generated
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// the type of id generated
	Type Types `protobuf:"varint,2,opt,name=type,proto3,enum=id.Types" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateResponse) Descriptor deprecated 

func (*GenerateResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateResponse.ProtoReflect.Descriptor instead.

func (*GenerateResponse) GetId 

func (x *GenerateResponse) GetId() string

func (*GenerateResponse) GetType 

func (x *GenerateResponse) GetType() Types

func (*GenerateResponse) ProtoMessage 

func (*GenerateResponse) ProtoMessage()

func (*GenerateResponse) ProtoReflect 

func (x *GenerateResponse) ProtoReflect() protoreflect.Message

func (*GenerateResponse) Reset 

func (x *GenerateResponse) Reset()

func (*GenerateResponse) String 

func (x *GenerateResponse) String() string

type IdClient 

type IdClient interface {
	Generate(ctx context.Context, in *GenerateRequest, opts ...grpc.CallOption) (*GenerateResponse, error)
	Types(ctx context.Context, in *TypesRequest, opts ...grpc.CallOption) (*TypesResponse, error)
}

IdClient is the client API for Id 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.

func NewIdClient 

func NewIdClient(cc grpc.ClientConnInterface) IdClient

type IdHandler 

type IdHandler interface {
	Generate(context.Context, *GenerateRequest, *GenerateResponse) error
	Types(context.Context, *TypesRequest, *TypesResponse) error
}

type IdServer 

type IdServer interface {
	Generate(context.Context, *GenerateRequest) (*GenerateResponse, error)
	Types(context.Context, *TypesRequest) (*TypesResponse, error)
	// contains filtered or unexported methods
}

IdServer is the server API for Id service. All implementations must embed UnimplementedIdServer for forward compatibility

type IdService 

type IdService interface {
	Generate(ctx context.Context, in *GenerateRequest, opts ...client.CallOption) (*GenerateResponse, error)
	Types(ctx context.Context, in *TypesRequest, opts ...client.CallOption) (*TypesResponse, error)
}

func NewIdService 

func NewIdService(name string, c client.Client) IdService

type Types 

type Types int32
const (
	Types_UUID      Types = 0
	Types_NANOID    Types = 1
	Types_ULID      Types = 2
	Types_KSUID     Types = 3
	Types_XID       Types = 4
	Types_SNOWFLAKE Types = 5
	Types_BIGFLAKE  Types = 6
	Types_SHORTID   Types = 7
)

func (Types) Descriptor 

func (Types) Descriptor() protoreflect.EnumDescriptor

func (Types) Enum 

func (x Types) Enum() *Types

func (Types) EnumDescriptor deprecated 

func (Types) EnumDescriptor() ([]byte, []int)

Deprecated: Use Types.Descriptor instead.

func (Types) Number 

func (x Types) Number() protoreflect.EnumNumber

func (Types) String 

func (x Types) String() string

func (Types) Type 

func (Types) Type() protoreflect.EnumType

type TypesRequest 

type TypesRequest struct {
	// contains filtered or unexported fields
}

List the types of IDs available.

func (*TypesRequest) Descriptor deprecated 

func (*TypesRequest) Descriptor() ([]byte, []int)

Deprecated: Use TypesRequest.ProtoReflect.Descriptor instead.

func (*TypesRequest) ProtoMessage 

func (*TypesRequest) ProtoMessage()

func (*TypesRequest) ProtoReflect 

func (x *TypesRequest) ProtoReflect() protoreflect.Message

func (*TypesRequest) Reset 

func (x *TypesRequest) Reset()

func (*TypesRequest) String 

func (x *TypesRequest) String() string

type TypesResponse 

type TypesResponse struct {
	Types []string `protobuf:"bytes,1,rep,name=types,proto3" json:"types,omitempty"`
	// contains filtered or unexported fields
}

func (*TypesResponse) Descriptor deprecated 

func (*TypesResponse) Descriptor() ([]byte, []int)

Deprecated: Use TypesResponse.ProtoReflect.Descriptor instead.

func (*TypesResponse) GetTypes 

func (x *TypesResponse) GetTypes() []string

func (*TypesResponse) ProtoMessage 

func (*TypesResponse) ProtoMessage()

func (*TypesResponse) ProtoReflect 

func (x *TypesResponse) ProtoReflect() protoreflect.Message

func (*TypesResponse) Reset 

func (x *TypesResponse) Reset()

func (*TypesResponse) String 

func (x *TypesResponse) String() string

type UnimplementedIdServer 

type UnimplementedIdServer struct {
}

UnimplementedIdServer must be embedded to have forward compatible implementations.

func (UnimplementedIdServer) Generate 

func (UnimplementedIdServer) Generate(context.Context, *GenerateRequest) (*GenerateResponse, error)

func (UnimplementedIdServer) Types 

func (UnimplementedIdServer) Types(context.Context, *TypesRequest) (*TypesResponse, error)

type UnsafeIdServer 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.