View Source Saxy.XML (Saxy v1.6.0)

Helper functions for building XML elements.

Summary

Types

cdata()

characters()

comment()

content()

dec_ref()

element()

entity_ref()

hex_ref()

processing_instruction()

ref()

Functions

cdata(text)

Builds CDATA in simple form.

characters(text)

Builds characters in simple form.

comment(text)

Builds comment in simple form.

element(name, attributes, children)

Builds element in simple form.

empty_element(name, attributes)

Builds empty element in simple form.

processing_instruction(name, instruction)

Builds processing instruction in simple form.

reference(character_type, name)

Builds reference in simple form.

Types

cdata()

@type cdata() :: {:cdata, String.t()}

characters()

@type characters() :: {:characters, String.t()}

comment()

@type comment() :: {:comment, String.t()}

content()

@type content() :: element() | characters() | cdata() | ref() | comment() | String.t()

dec_ref()

@type dec_ref() :: {:reference, {:decimal, integer()}}

element()

@type element() ::
  {name :: String.t(), attributes :: [{key :: String.t(), value :: String.t()}],
   children :: [content()]}

entity_ref()

@type entity_ref() :: {:reference, {:entity, String.t()}}

hex_ref()

@type hex_ref() :: {:reference, {:hexadecimal, integer()}}

processing_instruction()

@type processing_instruction() ::
  {:processing_instruction, name :: String.t(), instruction :: String.t()}

ref()

@type ref() :: entity_ref() | hex_ref() | dec_ref()

Functions

cdata(text)

@spec cdata(text :: term()) :: cdata()

Builds CDATA in simple form.

characters(text)

@spec characters(text :: term()) :: characters()

Builds characters in simple form.

comment(text)

@spec comment(text :: term()) :: comment()

Builds comment in simple form.

element(name, attributes, children)

@spec element(
  name :: term(),
  attributes :: [{key :: term(), value :: term()}],
  children :: term()
) :: element()

Builds element in simple form.

empty_element(name, attributes)

@spec empty_element(
  name :: term(),
  attributes :: [{key :: term(), value :: term()}]
) :: element()

Builds empty element in simple form.

processing_instruction(name, instruction)

@spec processing_instruction(
  name :: String.t(),
  instruction :: String.t()
) :: processing_instruction()

Builds processing instruction in simple form.

reference(character_type, name)

@spec reference(
  character_type :: :entity | :hexadecimal | :decimal,
  value :: term()
) :: ref()

Builds reference in simple form.