@spec all(xml(), xpath()) :: [XmlQuery.Element.t()]

Finds all elements in an XML document that match xpath, returning a list of records. Depending on the given xpath, the type of the record may be different.

@spec attr(xml(), String.t()) :: XmlQuery.Attribute.t() | nil

Returns the value of attr from the outermost element of xml.

@spec find(xml(), xpath()) ::
  XmlQuery.Element.t() | XmlQuery.Attribute.t() | XmlQuery.Text.t() | nil

Finds the first element, attribute, or element text in xml that matches xpath.

iex> alias XmlQuery, as: Xq
iex> xml = """
...> <?xml version="1.0"?>
...> <root><child property="oldest" /><child property="youngest" /></root>
...> """
iex> %Xq.Element{name: :child, attributes: [%Xq.Attribute{value: ~c"oldest"}]} = Xq.find(xml, "//child")

@spec find!(xml(), xpath()) ::
  XmlQuery.Element.t() | XmlQuery.Attribute.t() | XmlQuery.Text.t()

Like find/2 but raises unless exactly one node is found.

@spec parse(xml()) ::
  XmlQuery.Element.t() | XmlQuery.Attribute.t() | XmlQuery.Text.t()

Parses an XML document using :xmerl_scan.string/2, returning an XmlQuery.Element struct.

Given an xml tuple that has already been created by :xmerl, wraps the tuple in an XmlQuery-specific struct.

iex> xml = """
...> <?xml version="1.0"?>
...> <root />
...> """
iex> %Xq.Element{name: :root} = XmlQuery.parse(xml)

iex> xml = """
...> <?xml version="1.0"?>
...> <root property="root-value" />
...> """
iex> %Xq.Attribute{name: :property, value: ~c"root-value"} = XmlQuery.find(xml, "//root/@property") |> XmlQuery.parse()

@spec pretty(xml()) :: binary()

Returns xml as a prettified string.

Elements and text nodes are sorted and indented relative to parent elements.

@spec text(xml()) :: binary()

Returns the text value of xml.