go.uuid: github.com/satori/go.uuid Index | Files

package uuid

import "github.com/satori/go.uuid"

Package uuid provides implementation of Universally Unique Identifier (UUID). Supported versions are 1, 3, 4 and 5 (as specified in RFC 4122) and version 2 (as specified in DCE 1.1).

Index

Package Files

uuid.go

Constants

const (
    VariantNCS = iota
    VariantRFC4122
    VariantMicrosoft
    VariantFuture
)

UUID layout variants.

const (
    DomainPerson = iota
    DomainGroup
    DomainOrg
)

UUID DCE domains.

Variables

var (
    NamespaceDNS  = FromString("6ba7b810-9dad-11d1-80b4-00c04fd430c8")
    NamespaceURL  = FromString("6ba7b811-9dad-11d1-80b4-00c04fd430c8")
    NamespaceOID  = FromString("6ba7b812-9dad-11d1-80b4-00c04fd430c8")
    NamespaceX500 = FromString("6ba7b814-9dad-11d1-80b4-00c04fd430c8")
)

Predefined namespace UUIDs.

var Nil = UUID{}

The nil UUID is special form of UUID that is specified to have all 128 bits set to zero.

func Equal Uses

func Equal(u1 UUID, u2 UUID) bool

Equal returns true if u1 and u2 equals, otherwise returns false.

type NullUUID Uses

type NullUUID struct {
    UUID  UUID
    Valid bool
}

NullUUID can be used with the standard sql package to represent a UUID value that can be NULL in the database

func (*NullUUID) Scan Uses

func (u *NullUUID) Scan(src interface{}) error

Scan implements the sql.Scanner interface.

func (NullUUID) Value Uses

func (u NullUUID) Value() (driver.Value, error)

Value implements the driver.Valuer interface.

type UUID Uses

type UUID [16]byte

UUID representation compliant with specification described in RFC 4122.

func And Uses

func And(u1 UUID, u2 UUID) UUID

And returns result of binary AND of two UUIDs.

func FromBytes Uses

func FromBytes(input []byte) (u UUID, err error)

FromBytes returns UUID converted from raw byte slice input. It will return error if the slice isn't 16 bytes long.

func FromBytesOrNil Uses

func FromBytesOrNil(input []byte) UUID

FromBytesOrNil returns UUID converted from raw byte slice input. Same behavior as FromBytes, but returns a Nil UUID on error.

func FromString Uses

func FromString(input string) (u UUID, err error)

FromString returns UUID parsed from string input. Input is expected in a form accepted by UnmarshalText.

func FromStringOrNil Uses

func FromStringOrNil(input string) UUID

FromStringOrNil returns UUID parsed from string input. Same behavior as FromString, but returns a Nil UUID on error.

func NewV1 Uses

func NewV1() UUID

NewV1 returns UUID based on current timestamp and MAC address.

func NewV2 Uses

func NewV2(domain byte) UUID

NewV2 returns DCE Security UUID based on POSIX UID/GID.

func NewV3 Uses

func NewV3(ns UUID, name string) UUID

NewV3 returns UUID based on MD5 hash of namespace UUID and name.

func NewV4 Uses

func NewV4() UUID

NewV4 returns random generated UUID.

func NewV5 Uses

func NewV5(ns UUID, name string) UUID

NewV5 returns UUID based on SHA-1 hash of namespace UUID and name.

func Or Uses

func Or(u1 UUID, u2 UUID) UUID

Or returns result of binary OR of two UUIDs.

func (UUID) Bytes Uses

func (u UUID) Bytes() []byte

Bytes returns bytes slice representation of UUID.

func (UUID) MarshalBinary Uses

func (u UUID) MarshalBinary() (data []byte, err error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (UUID) MarshalText Uses

func (u UUID) MarshalText() (text []byte, err error)

MarshalText implements the encoding.TextMarshaler interface. The encoding is the same as returned by String.

func (*UUID) Scan Uses

func (u *UUID) Scan(src interface{}) error

Scan implements the sql.Scanner interface. A 16-byte slice is handled by UnmarshalBinary, while a longer byte slice or a string is handled by UnmarshalText.

func (*UUID) SetVariant Uses

func (u *UUID) SetVariant()

SetVariant sets variant bits as described in RFC 4122.

func (*UUID) SetVersion Uses

func (u *UUID) SetVersion(v byte)

SetVersion sets version bits.

func (UUID) String Uses

func (u UUID) String() string

Returns canonical string representation of UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

func (*UUID) UnmarshalBinary Uses

func (u *UUID) UnmarshalBinary(data []byte) (err error)

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface. It will return error if the slice isn't 16 bytes long.

func (*UUID) UnmarshalText Uses

func (u *UUID) UnmarshalText(text []byte) (err error)

UnmarshalText implements the encoding.TextUnmarshaler interface. Following formats are supported: "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "{6ba7b810-9dad-11d1-80b4-00c04fd430c8}", "urn:uuid:6ba7b810-9dad-11d1-80b4-00c04fd430c8"

func (UUID) Value Uses

func (u UUID) Value() (driver.Value, error)

Value implements the driver.Valuer interface.

func (UUID) Variant Uses

func (u UUID) Variant() uint

Variant returns UUID layout variant.

func (UUID) Version Uses

func (u UUID) Version() uint

Version returns algorithm version used to generate UUID.

Package uuid imports 13 packages (graph) and is imported by 1769 packages. Updated 2017-10-25. Refresh now. Tools for package owners.