default_encode/2

Author: josevalim

lib/elixir/lib/json.ex

@@ -333,7 +333,7 @@ defmodule JSON do
 
   """
   @spec encode!(a, (a -> iodata())) :: binary() when a: var
-  def encode!(term, encoder \\ &encode_value/2) do
+  def encode!(term, encoder \\ &default_encode/2) do
     IO.iodata_to_binary(encoder.(term, encoder))
   end
 
@@ -353,15 +353,19 @@ defmodule JSON do
       "[123,\"string\",{\"key\":\"value\"}]"
 
   """
-  @spec encode!(a, (a -> iodata())) :: iodata() when a: var
-  def encode_to_iodata!(term, encoder \\ &encode_value/2) do
+  @spec encode_to_iodata!(a, (a -> iodata())) :: iodata() when a: var
+  def encode_to_iodata!(term, encoder \\ &default_encode/2) do
     encoder.(term, encoder)
   end
 
   @doc """
-  This is the default function used to recursively encode each value.
+  This is the default encode implementation passed to `encode!/1`.
+
+  This function is most typically passed as second argument to
+  `encode!/2` and `encode_to_iodata!/2`. The default implementation
+  simply dispatches to `JSON.Encoder.encode/2`.
   """
-  def encode_value(value, encoder) when is_atom(value) do
+  def default_encode(value, encoder) when is_atom(value) do
     case value do
       nil -> "null"
       true -> "true"
@@ -370,21 +374,21 @@ defmodule JSON do
     end
   end
 
-  def encode_value(value, _encoder) when is_binary(value),
+  def default_encode(value, _encoder) when is_binary(value),
     do: :elixir_json.encode_binary(value)
 
-  def encode_value(value, _encoder) when is_integer(value),
+  def default_encode(value, _encoder) when is_integer(value),
     do: :elixir_json.encode_integer(value)
 
-  def encode_value(value, _encoder) when is_float(value),
+  def default_encode(value, _encoder) when is_float(value),
     do: :elixir_json.encode_float(value)
 
-  def encode_value(value, encoder) when is_list(value),
+  def default_encode(value, encoder) when is_list(value),
     do: :elixir_json.encode_list(value, encoder)
 
-  def encode_value(%{} = value, encoder) when not is_map_key(value, :__struct__),
+  def default_encode(%{} = value, encoder) when not is_map_key(value, :__struct__),
     do: :elixir_json.encode_map(value, encoder)
 
-  def encode_value(value, encoder),
+  def default_encode(value, encoder),
     do: JSON.Encoder.encode(value, encoder)
 end

lib/elixir/test/elixir/json_test.exs

@@ -51,7 +51,7 @@ defmodule JSONTest do
   describe "JSON.Encoder" do
     defp protocol_encode(term) do
       term
-      |> JSON.Encoder.encode(&JSON.encode_value/2)
+      |> JSON.Encoder.encode(&JSON.default_encode/2)
       |> IO.iodata_to_binary()
     end