Edit File - File Manager

Edit File: encoder.ex

defprotocol JSON.Encoder do
  @fallback_to_any true

@moduledoc """
  Defines the protocol required for converting Elixir types into JSON and inferring their json types.
  """

@doc """
  Returns a JSON string representation of the Elixir term

## Examples
      iex> JSON.Encoder.encode({1, :two, "three"})
      {:ok, "[1,\\\"two\\\",\\\"three\\\"]"}

iex> JSON.Encoder.encode([result: "this will be a elixir result"])
      {:ok, "{\\\"result\\\":\\\"this will be a elixir result\\\"}"}

iex> JSON.Encoder.encode(%{a: 1, b: 2})
      {:ok, "{\\\"a\\\":1,\\\"b\\\":2}"}
  """
  @spec encode(tuple | HashDict.t() | list | integer | float | map | list | atom | term) ::
          {atom, bitstring}
  def encode(term)

@doc """
  Returns an atom that reprsents the JSON type for the term

## Examples
      iex> JSON.Encoder.typeof(3)
      :number

iex> JSON.Encoder.typeof({1, :two, "three"})
      :array

iex> JSON.Encoder.typeof([foo: "this will be a elixir result"])
      :object

iex> JSON.Encoder.typeof([result: "this will be a elixir result"])
      :object

iex> JSON.Encoder.typeof(["this will be a elixir result"])
      :array

iex> JSON.Encoder.typeof([foo: "bar"])
      :object
  """
  @spec typeof(term) :: atom
  def typeof(term)
end

Back to File Manager