BSON (mongodb-driver v1.4.0) View Source

Functions for encoding and decoding BSON documents.

Link to this section Summary

Types

document()

t()

Functions

decode(iodata)

Decode iodata to a BSON document.

encode(map)

Encode a BSON document to iodata.

Link to this section Types

document()

Specs

document() ::
  %{required(atom()) => t()}
  | %{required(String.t()) => t()}
  | [{atom(), t()}]
  | [{String.t(), t()}]

t()

Specs

t() ::
  document()
  | String.t()
  | atom()
  | number()
  | boolean()
  | BSON.Binary.t()
  | BSON.ObjectId.t()
  | BSON.Regex.t()
  | BSON.JavaScript.t()
  | BSON.Timestamp.t()
  | BSON.LongNumber.t()
  | [t()]

Link to this section Functions

decode(iodata)

Specs

decode(iodata()) :: document()

Decode iodata to a BSON document.

encode(map)

Specs

encode(document()) :: iodata()

Encode a BSON document to iodata.