View Source Poison.Encoder protocol (Poison v6.0.0)

Summary

Types

t()

All the types that implement this protocol.

Types

@type escape() :: :unicode | :javascript | :html_safe
@type indent() :: non_neg_integer()
@type offset() :: non_neg_integer()
@type option() ::
  {:escape, escape()}
  | {:pretty, pretty()}
  | {:indent, indent()}
  | {:offset, offset()}
  | {:strict_keys, strict_keys()}
@type options() :: %{
  optional(:escape) => escape(),
  optional(:pretty) => pretty(),
  optional(:indent) => indent(),
  optional(:offset) => offset(),
  optional(:strict_keys) => strict_keys()
}
@type pretty() :: boolean()
@type strict_keys() :: boolean()
@type t() :: term()

All the types that implement this protocol.

Functions

@spec encode(t(), options()) :: iodata()