objectid

Documentation

Overview

Package objectid contains an implementation of a BSON objectID type functions to create objectIDs.

Index

• Variables
• type ObjectID
  • func FromHex(s string) (ObjectID, error)
  • func New() ObjectID
  • func (id ObjectID) Hex() string
  • func (id ObjectID) IsZero() bool
  • func (id ObjectID) MarshalJSON() ([]byte, error)
  • func (id ObjectID) String() string
  • func (id *ObjectID) UnmarshalJSON(b []byte) error

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 FromHex

func FromHex(s string) (ObjectID, error)

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

func New

func New() ObjectID

New generates a new ObjectID.

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.

func (ObjectID) MarshalJSON

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

MarshalJSON returns the ObjectID as a string

func (ObjectID) String

func (id ObjectID) String() string

func (*ObjectID) UnmarshalJSON

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

UnmarshalJSON populates the byte slice with the ObjectID. If the byte slice is 64 bytes long, it will be populated with the hex representation of the ObjectID. If the byte slice is twelve bytes long, it will be populated with the BSON representation of the ObjectID. Otherwise, it will return an error.