xid

Documentation

Index

• Variables
• func Sort(ids []ID)
• type ID
  • func FromBytes(b []byte) (ID, error)
  • func FromString(id string) (ID, error)
  • func New() ID
  • func NewWithTime(t time.Time) ID
  • func NilID() ID
  • func (id ID) Bytes() []byte
  • func (id ID) Compare(other ID) int
  • func (id ID) Counter() int32
  • func (id ID) IsNil() bool
  • func (id ID) Machine() []byte
  • func (id ID) MarshalJSON() ([]byte, error)
  • func (id ID) MarshalText() ([]byte, error)
  • func (id ID) Pid() uint16
  • func (id *ID) Scan(value interface{}) (err error)
  • func (id ID) String() string
  • func (id ID) Time() time.Time
  • func (id *ID) UnmarshalJSON(b []byte) error
  • func (id *ID) UnmarshalText(text []byte) error
  • func (id ID) Value() (driver.Value, error)

Variables

var (
	// ErrInvalidID is returned when trying to unmarshal an invalid ID
	ErrInvalidID = errors.New("xid: invalid ID")
)

Functions

func Sort

func Sort(ids []ID)

Sort sorts an array of IDs inplace. It works by wrapping `[]ID` and use `sort.Sort`.

Types

type ID

type ID [rawLen]byte

ID represents a unique request id

func FromBytes

func FromBytes(b []byte) (ID, error)

FromBytes convert the byte array representation of `ID` back to `ID`

func FromString

func FromString(id string) (ID, error)

FromString reads an ID from its string representation

func New

func New() ID

New generates a globally unique ID

func NewWithTime

func NewWithTime(t time.Time) ID

NewWithTime generates a globally unique ID with the passed in time

func NilID

func NilID() ID

NilID returns a zero value for `xid.ID`.

func (ID) Bytes

func (id ID) Bytes() []byte

Bytes returns the byte array representation of `ID`

func (ID) Compare

func (id ID) Compare(other ID) int

Compare returns an integer comparing two IDs. It behaves just like `bytes.Compare`. The result will be 0 if two IDs are identical, -1 if current id is less than the other one, and 1 if current id is greater than the other.

func (ID) Counter

func (id ID) Counter() int32

Counter returns the incrementing value part of the id. It's a runtime error to call this method with an invalid id.

func (ID) IsNil

func (id ID) IsNil() bool

IsNil Returns true if this is a "nil" ID

func (ID) Machine

func (id ID) Machine() []byte

Machine returns the 3-byte machine id part of the id. It's a runtime error to call this method with an invalid id.

func (ID) MarshalJSON

func (id ID) MarshalJSON() ([]byte, error)

MarshalJSON implements encoding/json Marshaler interface

func (ID) MarshalText

func (id ID) MarshalText() ([]byte, error)

MarshalText implements encoding/text TextMarshaler interface

func (ID) Pid

func (id ID) Pid() uint16

Pid returns the process id part of the id. It's a runtime error to call this method with an invalid id.

func (*ID) Scan

func (id *ID) Scan(value interface{}) (err error)

Scan implements the sql.Scanner interface.

func (ID) String

func (id ID) String() string

String returns a base32 hex lowercased with no padding representation of the id (char set is 0-9, a-v).

func (ID) Time

func (id ID) Time() time.Time

Time returns the timestamp part of the id. It's a runtime error to call this method with an invalid id.

func (*ID) UnmarshalJSON

func (id *ID) UnmarshalJSON(b []byte) error

UnmarshalJSON implements encoding/json Unmarshaler interface

func (*ID) UnmarshalText

func (id *ID) UnmarshalText(text []byte) error

UnmarshalText implements encoding/text TextUnmarshaler interface

func (ID) Value

func (id ID) Value() (driver.Value, error)

Value implements the driver.Valuer interface.