antikythera v0.4.0 Antikythera.Xml.Element View Source

Link to this section Summary

Functions

Type-aware getter for attributes.

Type-aware setter for attributes.

Type-aware getter for children.

Type-aware setter for children.

Type-aware getter for name.

Type-aware setter for name.

Creates a new instance of Antikythera.Xml.Element by using the given dict.

A variant of new/1 which returns t or raise if validation fails.

Updates an existing instance of Antikythera.Xml.Element with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

Checks if the given value belongs to t/0 or not.

Link to this section Types

Specs

t() :: %Antikythera.Xml.Element{
  attributes: Croma.Map.t(),
  children: Croma.TypeGen.ListOf.Antikythera.Xml.Content.t(),
  name: Croma.String.t()
}

Link to this section Functions

Specs

attributes(t()) :: Croma.Map.t()

Type-aware getter for attributes.

Specs

attributes(t(), Croma.Map.t()) :: t()

Type-aware setter for attributes.

Specs

children(t()) :: Croma.TypeGen.ListOf.Antikythera.Xml.Content.t()

Type-aware getter for children.

Specs

children(t(), Croma.TypeGen.ListOf.Antikythera.Xml.Content.t()) :: t()

Type-aware setter for children.

Specs

name(t()) :: Croma.String.t()

Type-aware getter for name.

Specs

name(t(), Croma.String.t()) :: t()

Type-aware setter for name.

Specs

new(term()) :: Croma.Result.t(t())

Creates a new instance of Antikythera.Xml.Element by using the given dict.

Returns {:ok, valid_struct} or {:error, reason}.

The values in the dict are validated by each field's valid?/1 function. If the value was invalid, it will be passed to new/1 of the field

For missing fields, followings will be tried:

  • default/0 of each field type
  • new/1 of each field type, with empty map as input

Specs

new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

Specs

update(t(), Dict.t()) :: Croma.Result.t(t())

Updates an existing instance of Antikythera.Xml.Element with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

Specs

update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

Specs

valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.