pulid

package

v0.0.0-...-8b6722b Latest Latest Go to latest Published: Feb 24, 2023 License: MIT Imports: 7 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

View Source

const PrefixLength = 3

Separator between prefix and the ULID.

View Source

const Separator = '_'

View Source

var ErrIncorrectPULIDFormat = fmt.Errorf("pulid: incorrect format")

ErrIncorrectPULIDFormat is returned when the PULID is not in the correct format.

func IsAPULID(pulid PULID) error

IsAPULID checks if this is a valid PULID.

func ParsePULID(pulid PULID) (string, string, error)

ParsePULID returns the prefix and ULID from a PULID.

type PULID string

Prefixed ULID with object type - globally universal ID.

func NewPULID(prefix string) PULID

Creates a new PULID.

func (pulid PULID) MarshalGQL(w io.Writer)

Marshals a PULID into a graphql scalar string.

func (pulid *PULID) Scan(src interface{}) error

Scans a database value to a PULID Go type.

func (pulid PULID) String() string

Returns a PULID value as a string.

func (pulid *PULID) UnmarshalGQL(v interface{}) error

Unmarshals a graphql scalar into a PULID Go type.

func (pulid PULID) Value() (driver.Value, error)

Transforms a PULID type to database value string.