Kuddle.V1.Decoder (Kuddle v1.1.1)

Tokenizes and parses KDL documents into kuddle documents.

Summary

document()

A kuddle document is a list of Kuddle Nodes

document_node()

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.

decode(blob)

Tokenize and parse a given KDL document.

decode!(blob)

Same as decode/1, but will raise a Kuddle.DecodeError on error from decode.

@type document() :: [document_node()]

A kuddle document is a list of Kuddle Nodes

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

A single node in the Kuddle document

@type tokens() :: Kuddle.V1.Tokenizer.tokens()

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

@spec 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.

@spec decode!(String.t()) :: document()

Same as decode/1, but will raise a Kuddle.DecodeError on error from decode.