Protocol for building XML content.

Deriving

This helps to generate XML content simple form in trivial cases.

There are a few required options:

• name - tag name of generated XML element.
• attributes - fields to be encoded as attributes.
• children - fields to be encoded as element children.

Examples

defmodule Person do
  @derive {Sax.Builder, name: "person", attributes: [:gender], children: [:name]}

  defstruct [:name, :gender]
end

iex> person = %Person{name: "Alice", gender: "female"}
iex> Sax.Builder.build(person)
{"person", [{"gender", "female"}], [{:characters, "Alice"}]}

Custom implementation could be done by implementing protocol:

defmodule User do
  defstruct [:username, :name]
end

defimpl Sax.Builder do
  import Sax.XML

  def build(user) do
    element(
      "Person",
      [{"userName", user.username}],
      [element("Name", [], user.name)]
    )
  end
end

iex> user = %User{name: "Alice", username: "alice99"}
iex> Sax.Builder.build(user)
{"Person", [{"userName", "alice99"}], [{"Name", [], [characters: "Alice"]}]}