Dumbo.DecodeOpts (Dumbo v0.3.2)

Copy Markdown View Source

Options for configuring decoding behavior.

Fields

  • :object_resolvers - A map of PHP class names to resolvers. Each resolver is a function of arity 1 or a module implementing Dumbo.ObjectResolver. Defaults to Dumbo.PHP.resolvers().

  • :use_native_decoders - When true (the default) and dumbo_nif is installed, numeric floats are parsed by that precompiled NIF. Set to false for the pure-Elixir path. Ignored without dumbo_nif.

  • :resolve_references - When true (the default), R:/r: references are resolved. When false, the value stack is not built and any reference raises Dumbo.DecodeError.

Summary

Types

object_resolver()
t()

Types

object_resolver()

@type object_resolver() :: (object :: map() -> term()) | module()

t()

@type t() :: %Dumbo.DecodeOpts{
  object_resolvers: %{required(object_name :: binary()) => object_resolver()},
  resolve_references: boolean(),
  use_native_decoders: boolean()
}