id

package
v1.9.1 Latest Latest
Warning

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

 Go to latest Published: Oct 28, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package id defines TypeID-based identity types for all Nexus entities.

Every entity in Nexus uses a single ID struct with a prefix that identifies the entity type. IDs are K-sortable (UUIDv7-based), globally unique, and URL-safe in the format "prefix_suffix".

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AnyID 

type AnyID = ID

AnyID is an alias for ID (backward compatibility).

type ID 

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

ID is the primary identifier type for all Nexus entities. It wraps a TypeID providing a prefix-qualified, globally unique, sortable, URL-safe identifier in the format "prefix_suffix". 

var Nil ID

Nil is the zero-value ID.

func MustParse 

func MustParse(s string) ID

MustParse is like Parse but panics on error. Use for hardcoded ID values.

func MustParseKeyID 

func MustParseKeyID(s string) ID

MustParseKeyID parses a KeyID or panics.

func MustParseRequestID 

func MustParseRequestID(s string) ID

MustParseRequestID parses a RequestID or panics.

func MustParseTenantID 

func MustParseTenantID(s string) ID

MustParseTenantID parses a TenantID or panics.

func MustParseUsageID 

func MustParseUsageID(s string) ID

MustParseUsageID parses a UsageID or panics.

func MustParseWithPrefix 

func MustParseWithPrefix(s string, expected Prefix) ID

MustParseWithPrefix is like ParseWithPrefix but panics on error.

func New 

func New(prefix Prefix) ID

New generates a new globally unique ID with the given prefix. It panics if prefix is not a valid TypeID prefix (programming error).

func NewKeyID 

func NewKeyID() ID

NewKeyID generates a new unique API key ID.

func NewRequestID 

func NewRequestID() ID

NewRequestID generates a new unique request ID.

func NewTenantID 

func NewTenantID() ID

NewTenantID generates a new unique tenant ID.

func NewUsageID 

func NewUsageID() ID

NewUsageID generates a new unique usage record ID.

func Parse 

func Parse(s string) (ID, error)

Parse parses a TypeID string (e.g., "tenant_01h455vb4pex5vsknk084sn02q") into an ID. Returns an error if the string is not valid.

func ParseAny 

func ParseAny(s string) (ID, error)

ParseAny parses a string into an ID without type checking the prefix.

func ParseKeyID 

func ParseKeyID(s string) (ID, error)

ParseKeyID parses a string and validates the "key" prefix.

func ParseRequestID 

func ParseRequestID(s string) (ID, error)

ParseRequestID parses a string and validates the "req" prefix.

func ParseTenantID 

func ParseTenantID(s string) (ID, error)

ParseTenantID parses a string and validates the "tenant" prefix.

func ParseUsageID 

func ParseUsageID(s string) (ID, error)

ParseUsageID parses a string and validates the "usage" prefix.

func ParseWithPrefix 

func ParseWithPrefix(s string, expected Prefix) (ID, error)

ParseWithPrefix parses a TypeID string and validates that its prefix matches the expected value.

func (ID) IsNil 

func (i ID) IsNil() bool

IsNil reports whether this ID is the zero value.

func (ID) MarshalBSONValue 

func (i ID) MarshalBSONValue() (bsonType byte, data []byte, err error)

MarshalBSONValue satisfies bson.ValueMarshaler (mongo-driver v2) so the ID is stored as a BSON string instead of an opaque struct. No bson import needed because Go uses structural typing for interface satisfaction.

func (ID) MarshalText 

func (i ID) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (ID) Prefix 

func (i ID) Prefix() Prefix

Prefix returns the prefix component of this ID.

func (*ID) Scan 

func (i *ID) Scan(src any) error

Scan implements sql.Scanner for database retrieval.

func (ID) String 

func (i ID) String() string

String returns the full TypeID string representation (prefix_suffix). Returns an empty string for the Nil ID.

func (*ID) UnmarshalBSONValue 

func (i *ID) UnmarshalBSONValue(t byte, data []byte) error

UnmarshalBSONValue satisfies bson.ValueUnmarshaler (mongo-driver v2).

func (*ID) UnmarshalText 

func (i *ID) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (ID) Value 

func (i ID) Value() (driver.Value, error)

Value implements driver.Valuer for database storage. Returns nil for the Nil ID so that optional foreign key columns store NULL.

type KeyID 

type KeyID = ID

KeyID is an alias for ID (backward compatibility).

type Prefix 

type Prefix string

Prefix identifies the entity type encoded in a TypeID. 

const (
	PrefixTenant  Prefix = "tenant"
	PrefixKey     Prefix = "key"
	PrefixUsage   Prefix = "usage"
	PrefixRequest Prefix = "req"
)

Prefix constants for all Nexus entity types.

type RequestID 

type RequestID = ID

RequestID is an alias for ID (backward compatibility).

type TenantID 

type TenantID = ID

TenantID is an alias for ID (backward compatibility).

type UsageID 

type UsageID = ID

UsageID is an alias for ID (backward compatibility).

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.