Kuddle.Decoder (Kuddle v0.2.1) View Source

Tokenizes and parses KDL documents into kuddle documents.

Link to this section Summary

A kuddle document is a list of Kuddle Nodes

A single node in the Kuddle document

tokens()

Parsed tokens from the Tokenizer, these will be processed and converted into the final nodes for the document.

Tokenize and parse a given KDL document.

document() :: [document_node()]

A kuddle document is a list of Kuddle Nodes

document_node() :: Kuddle.Node.t()

A single node in the Kuddle document

tokens() :: Kuddle.Tokenizer.tokens()

Parsed tokens from the Tokenizer, these will be processed and converted into the final nodes for the document.

decode(String.t()) :: {:ok, document(), tokens()} | {:error, term()}

Tokenize and parse a given KDL document.

If successful, it will return {:ok, document, tokens}, where document is the list of nodes that were parsed and tokens are any unparsed tokens.