Documentation
¶
Overview ¶
Package id defines TypeID-based identity types for all Trove entities.
Every entity in Trove 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 ¶
- type ID
- func MustParse(s string) ID
- func MustParseWithPrefix(s string, expected Prefix) ID
- func New(prefix Prefix) ID
- func NewBucketID() ID
- func NewChunkID() ID
- func NewDownloadSessionID() ID
- func NewObjectID() ID
- func NewPoolID() ID
- func NewStreamID() ID
- func NewUploadSessionID() ID
- func NewVersionID() ID
- func Parse(s string) (ID, error)
- func ParseAny(s string) (ID, error)
- func ParseBucketID(s string) (ID, error)
- func ParseChunkID(s string) (ID, error)
- func ParseDownloadSessionID(s string) (ID, error)
- func ParseObjectID(s string) (ID, error)
- func ParsePoolID(s string) (ID, error)
- func ParseStreamID(s string) (ID, error)
- func ParseUploadSessionID(s string) (ID, error)
- func ParseVersionID(s string) (ID, error)
- func ParseWithPrefix(s string, expected Prefix) (ID, error)
- func (i ID) IsNil() bool
- func (i ID) MarshalBSONValue() (bsonType byte, data []byte, err error)
- func (i ID) MarshalText() ([]byte, error)
- func (i ID) Prefix() Prefix
- func (i *ID) Scan(src any) error
- func (i ID) String() string
- func (i *ID) UnmarshalBSONValue(t byte, data []byte) error
- func (i *ID) UnmarshalText(data []byte) error
- func (i ID) Value() (driver.Value, error)
- type Prefix
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ID ¶
type ID struct {
// contains filtered or unexported fields
}
ID is the primary identifier type for all Trove 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 MustParseWithPrefix ¶
MustParseWithPrefix is like ParseWithPrefix but panics on error.
func New ¶
New generates a new globally unique ID with the given prefix. It panics if prefix is not a valid TypeID prefix (programming error).
func NewDownloadSessionID ¶
func NewDownloadSessionID() ID
NewDownloadSessionID generates a new unique download session ID.
func NewUploadSessionID ¶
func NewUploadSessionID() ID
NewUploadSessionID generates a new unique upload session ID.
func Parse ¶
Parse parses a TypeID string (e.g., "obj_01h455vb4pex5vsknk084sn02q") into an ID. Returns an error if the string is not valid.
func ParseBucketID ¶
ParseBucketID parses a string and validates the "bkt" prefix.
func ParseChunkID ¶
ParseChunkID parses a string and validates the "chk" prefix.
func ParseDownloadSessionID ¶
ParseDownloadSessionID parses a string and validates the "dwn" prefix.
func ParseObjectID ¶
ParseObjectID parses a string and validates the "obj" prefix.
func ParsePoolID ¶
ParsePoolID parses a string and validates the "pol" prefix.
func ParseStreamID ¶
ParseStreamID parses a string and validates the "str" prefix.
func ParseUploadSessionID ¶
ParseUploadSessionID parses a string and validates the "upl" prefix.
func ParseVersionID ¶
ParseVersionID parses a string and validates the "ver" prefix.
func ParseWithPrefix ¶
ParseWithPrefix parses a TypeID string and validates that its prefix matches the expected value.
func (ID) MarshalBSONValue ¶
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 ¶
MarshalText implements encoding.TextMarshaler.
func (ID) String ¶
String returns the full TypeID string representation (prefix_suffix). Returns an empty string for the Nil ID.
func (*ID) UnmarshalBSONValue ¶
UnmarshalBSONValue satisfies bson.ValueUnmarshaler (mongo-driver v2).
func (*ID) UnmarshalText ¶
UnmarshalText implements encoding.TextUnmarshaler.
Source Files