eyed

package module

v0.0.0-...-d33a6f3 Latest Latest Go to latest Published: Dec 17, 2021 License: MIT Imports: 5 Imported by: 0

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/knation/go-eyed

Links

Open Source Insights

README ¶

go-eyed

A go module for "friendly" IDs.

THIS MODULE IS INCOMPLETE AND NOT CURRENTLY BEING MAINTAINED. THEREFORE, IT SHOULD NOT BE USED

Contribution

If someone would like to contribute to or take over this project, please let me know :)

Notable TODOs

Implement Stringer
Implement database/sql.Scanner and database/sql/driver.Valuer
Play nice with encoding.BinaryMarshal and encoding.BinaryUnmarshal
Support encoding.TextMarshal and encoding.TextUnmarshal (encoding/json friendly)

Documentation ¶

Index ¶

type EYED
- func Parse(id string) (EYED, bool)
type EYEDType
- func GetType(id string) (*EYEDType, bool)
- func RegisterType(name string, prefix string) *EYEDType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type EYED ¶

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

EYEDs will be 28 characters (including the underscore) plus the length of the prefix.

func Parse ¶

func Parse(id string) (EYED, bool)

Parses the given ID string and returns an EYED object

func (EYED) Ksuid ¶

func (id EYED) Ksuid() ksuid.KSUID

Returns the KSUID for the given EYED

func (EYED) String ¶

func (id EYED) String() string

Returns the string reprsentation of the ID

func (EYED) Type ¶

func (id EYED) Type() *EYEDType

Returns the EYEDType for the given EYED

type EYEDType ¶

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

EYEDType is used to differentiate between different ID types with different prefixes.

func GetType ¶

func GetType(id string) (*EYEDType, bool)

Gets the EYEDType for the given ID string

func RegisterType ¶

func RegisterType(name string, prefix string) *EYEDType

Registers a new distinct type of EYED

func (*EYEDType) Is ¶

func (idType *EYEDType) Is(id string) bool

Checks if the given ID matches the type

func (*EYEDType) Name ¶

func (idType *EYEDType) Name() string

Returns the name of an EYEDType

func (*EYEDType) New ¶

func (idType *EYEDType) New() EYED

Creates a new EYED of the give type

func (*EYEDType) Prefix ¶

func (idType *EYEDType) Prefix() string

Returns the prefix of an EYEDType

func (*EYEDType) Value ¶

func (id *EYEDType) Value() (driver.Value, error)

Source Files ¶

View all Source files

eyed.go

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