ForkPoison.Decoder protocol (ForkForkPoison v6.0.1)

Copy Markdown View Source

Summary

Types

t()

All the types that implement this protocol.

Types

as()

@type as() :: map() | struct() | [as()] | (t() -> as())

decimal()

@type decimal() :: boolean()

keys()

@type keys() :: :atoms | :atoms!

option()

@type option() :: {:keys, keys()} | {:decimal, decimal()} | {:as, as()}

options()

@type options() :: %{
  optional(:keys) => keys(),
  optional(:decimal) => decimal(),
  optional(:as) => as()
}

t()

@type t() :: term()

All the types that implement this protocol.

Functions

decode(value, options)

@spec decode(t(), options()) :: any()