shortuuid

package module

v2.0.1 Latest Latest Go to latest Published: Oct 6, 2021 License: MIT Imports: 4 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

This package is a simple Go port of the PHP shortuuid library https://github.com/pascaldevink/shortuuid

This section is empty.

This section is empty.

This section is empty.

type ShortUUID string

ShortUUID type for working with ShortUUIDs.

func FromString(s string) (ShortUUID, error)

FromString returns a ShortUUID from a string representation.

func FromUUID(u uuid.UUID) ShortUUID

FromUUID converts a UUID into a ShortUUID.

func NewV1() (ShortUUID, error)

NewV1 returns a ShortUUID based on a V1 UUID.

func NewV3(ns uuid.UUID, name string) ShortUUID

NewV3 returns a ShortUUID based on a V3 UUID.

func NewV4() (ShortUUID, error)

NewV4 returns a ShortUUID based on a V4 UUID.

func NewV5(ns uuid.UUID, name string) ShortUUID

NewV5 returns a ShortUUID based on a V5 UUID.

func (s ShortUUID) String() string

func (s ShortUUID) UUID() uuid.UUID

UUID converts a ShortUUID into a UUID.