YAMLStar (yamlstar v0.1.17)

Elixir binding/API for the libyamlstar shared library.

This module is an Elixir port of the Python 'yamlstar' module, the reference implementation for YAMLStar FFI bindings to libyamlstar.

The load/1 function takes a YAML string as input and returns {:ok, data} with the loaded value, or {:error, message}. The load!/1 variant returns the data directly and raises YAMLStar.Error on failure.

Summary

Functions

load(input)

Load a YAML string and return the result.

load!(input)

Like load/1 but returns the data directly and raises YAMLStar.Error on failure.

Functions

load(input)

@spec load(String.t()) :: {:ok, term()} | {:error, String.t()}

Load a YAML string and return the result.

load!(input)

@spec load!(String.t()) :: term()

Like load/1 but returns the data directly and raises YAMLStar.Error on failure.