Kuddle.V2.Encoder (Kuddle v1.1.1)

Copy Markdown View Source

Encodes a Kuddle document into a KDL blob

Summary

Functions

Encodes a kuddle document as a KDL string

Same as encode/1,2, but will raise a Kuddle.EncodeError on error from decode.

Types

document()

@type document() :: Kuddle.V2.Decoder.document()

Functions

encode(document, options \\ [])

@spec encode(document(), Keyword.t()) :: {:ok, String.t()} | {:error, term()}

Encodes a kuddle document as a KDL string

encode!(document, options \\ [])

@spec encode!(document(), Keyword.t()) :: String.t()

Same as encode/1,2, but will raise a Kuddle.EncodeError on error from decode.