yaml

Wraps upstream YAML values so they can use MoonBit's standard JSON conversion traits without violating foreign-trait rules. See the module README for consumer setup and package imports.

#Usage

Convert structured JSON-compatible configuration through the YAML wrapper while preserving nested values.

///|
test "convert a structured JSON value to YAML and back" {
  let configuration : Yaml = @json.from_json(
    @json.parse(
      (
        #|{
        #|  "name": "example",
        #|  "enabled": true,
        #|  "items": ["a", null]
        #|}
      ),
    ),
  )
  @json.json_inspect(configuration.to_json(), content={
    "name": "example",
    "enabled": true,
    "items": ["a", null],
  })
}

#Package behavior

Converts nested YAML maps and arrays to JSON.
Preserves integer representations when decoding JSON numbers where possible.
Rejects non-finite numbers because JSON cannot represent them.

#API

Mooncakes API reference

This README was generated from the share-artifact skill and README template.

Yaml

source

pub struct Yaml {
  value : @moonbit-community/yaml.Yaml
Yaml
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Owns an upstream YAML value so standard JSON traits can be implemented without violating MoonBit's foreign-trait implementation rule.

impl ToJson for Yaml

fn to_json(self : Yaml) -> Json

source

Converts wrapped YAML into flat JSON.

YAML inf and nan reals abort conversion because JSON cannot represent non-finite numbers. Yaml::BadValue also has no JSON representation.

impl FromJson for Yaml

fn from_json(json : Json, path : @moonbitlang/core/json.JsonPath
JsonPath) -> Yaml raise @moonbitlang/core/json.JsonDecodeError
JsonDecodeError

source

Converts JSON values into the corresponding flat wrapped YAML value.

JSON numbers with an integer representation become Yaml::Integer; all other finite JSON numbers become Yaml::Real. Non-finite numbers are rejected, and Yaml::BadValue is never produced.

Yaml::Yaml

source

fn Yaml::Yaml(value : @moonbit-community/yaml.Yaml
Yaml) -> Yaml

Wraps an upstream YAML value for standard JSON conversion.

Yaml::to_json

source

fn Yaml::to_json(self : Yaml) -> Json

Source Files

yaml.mbt

Site source Report issue Packages Build queue Skills Statistics

#totto2727/x/yaml

#Usage

#Package behavior

#API

#Yaml

#Yaml::Yaml

#Yaml::to_json

Source Files

Yaml

Yaml::Yaml

Yaml::to_json