objectid

Documentation

Index

• Variables
• type ObjectID
  • func New() ObjectID
  • func NewFromHex(s string) (ObjectID, error)
  • func NewFromTimestamp(timestamp time.Time) ObjectID
  • func (id ObjectID) Hex() string
  • func (id ObjectID) IsZero() bool

Variables

var ErrInvalidHex = errors.New("the provided hex string is not a valid ObjectID")

ErrInvalidHex indicates that a hex string cannot be converted to an ObjectID.

Types

type ObjectID

type ObjectID [12]byte

ObjectID is the BSON ObjectID type.

var NilObjectID ObjectID

NilObjectID is the zero value for ObjectID.

func New

func New() ObjectID

New generates a new ObjectID.

func NewFromHex

func NewFromHex(s string) (ObjectID, error)

NewFromHex creates a new ObjectID from a hex string. It returns an error if the hex string is not a valid ObjectID.

func NewFromTimestamp

func NewFromTimestamp(timestamp time.Time) ObjectID

NewFromTimestamp generates a new ObjectID based on the given time.

func (ObjectID) Hex

func (id ObjectID) Hex() string

Hex returns the hex encoding of the ObjectID as a string.

func (ObjectID) IsZero

func (id ObjectID) IsZero() bool

IsZero returns true if id is the empty ObjectID.