cyanide v1.0.1

Cyanide (cyanide v1.0.1) View Source

Link to this section Summary

Types

bson_map()
bson_type()
encodable_map()
encodable_map_key()

Functions

decode(document)
decode!(document)
encode(document)
encode!(document)

Link to this section Types

Link to this type

bson_map()

View Source

Specs

bson_map() :: %{optional(String.t()) => bson_type()}
Link to this type

bson_type()

View Source

Specs

bson_type() ::
  float()
  | String.t()
  | bson_map()
  | [bson_type()]
  | {integer(), binary()}
  | boolean()
  | nil
  | integer()
  | DateTime.t()
Link to this type

encodable_map()

View Source

Specs

encodable_map() :: %{required(encodable_map_key()) => bson_type()}
Link to this type

encodable_map_key()

View Source

Specs

encodable_map_key() :: atom() | String.t()

Link to this section Functions

Link to this function

decode(document)

View Source

Specs

decode(binary()) :: {:ok, bson_map()} | {:error, :invalid_bson}
Link to this function

decode!(document)

View Source

Specs

decode!(binary()) :: bson_map()
Link to this function

encode(document)

View Source

Specs

encode(encodable_map()) :: {:ok, binary()} | {:error, :cannot_bson_encode}
Link to this function

encode!(document)

View Source

Specs

encode!(encodable_map()) :: binary()