types

Documentation

Index

• Variables
• type Binary
• type CodeWithScope
  • func (cws CodeWithScope) String() string
• type DBPointer
  • func (d DBPointer) String() string
• type DateTime
• type Decimal128
  • func NewDecimal128(h, l uint64) Decimal128
  • func ParseDecimal128(s string) (Decimal128, error)
  • func (d Decimal128) GetBytes() (uint64, uint64)
  • func (d Decimal128) String() string
• type JavaScriptCode
• type ObjectID
  • func MustObjectIDFromHex(s string) ObjectID
  • func NewObjectID() ObjectID
  • func ObjectIDFromHex(s string) (ObjectID, error)
  • 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
• type Regex
  • func (r Regex) String() string
• type Symbol
• type Timestamp

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.

var MaxKey struct{}

MaxKey represents the BSON minkey value.

var MinKey struct{}

MinKey represents the BSON maxkey value.

var Null struct{}

Null represents the BSON null value.

var Undefined struct{}

Undefined represents the BSON undefined value.

Types

type Binary

type Binary struct {
	Subtype byte
	Data    []byte
}

Binary represents a BSON binary value.

type CodeWithScope

type CodeWithScope struct {
	Code  string
	Scope []byte
}

CodeWithScope represents a BSON JavaScript code with scope value.

func (CodeWithScope) String

func (cws CodeWithScope) String() string

type DBPointer

type DBPointer struct {
	DB      string
	Pointer ObjectID
}

DBPointer represents a BSON dbpointer value.

func (DBPointer) String

func (d DBPointer) String() string

type DateTime

type DateTime int64

DateTime represents the BSON datetime value.

type Decimal128

type Decimal128 struct {
	// contains filtered or unexported fields
}

Decimal128 holds decimal128 BSON values.

func NewDecimal128

func NewDecimal128(h, l uint64) Decimal128

NewDecimal128 creates a Decimal128 using the provide high and low uint64s.

func ParseDecimal128

func ParseDecimal128(s string) (Decimal128, error)

ParseDecimal128 takes the given string and attempts to parse it into a valid Decimal128 value.

func (Decimal128) GetBytes

func (d Decimal128) GetBytes() (uint64, uint64)

GetBytes returns the underlying bytes of the BSON decimal value as two uint16 values. The first contains the most first 8 bytes of the value and the second contains the latter.

func (Decimal128) String

func (d Decimal128) String() string

String returns a string representation of the decimal value.

type JavaScriptCode

type JavaScriptCode string

JavaScriptCode represents a BSON JavaScript code value.

type ObjectID

type ObjectID [12]byte

ObjectID is the BSON ObjectID type.

var NilObjectID ObjectID

NilObjectID is the zero value for ObjectID.

func MustObjectIDFromHex

func MustObjectIDFromHex(s string) ObjectID

MustObjectIDFromHex builds an ObjectID, panicing if the hex string isn't valid

func NewObjectID

func NewObjectID() ObjectID

New generates a new ObjectID.

func ObjectIDFromHex

func ObjectIDFromHex(s string) (ObjectID, error)

ObjectIDFromHex creates a new ObjectID from a hex string. It returns an error if the hex string is not a valid 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.

type Regex

type Regex struct {
	Pattern string
	Options string
}

Regex represents a BSON regex value.

func (Regex) String

func (r Regex) String() string

type Symbol

type Symbol string

Symbol represents a BSON symbol value.

type Timestamp

type Timestamp struct {
	T uint32
	I uint32
}

Timestamp represents a BSON timestamp value.