Skip to content

std::encoding::yaml

Status: experimental

YAML 1.2 parser/emitter (serde_norway-backed).

API details and source

The implementation source contains the complete declarations and implementation notes. The table below lists canonical Gossamer call signatures; every item name links directly to its implementation file.

Item Canonical signature or declaration Description
Value type Value Dynamically typed YAML value.
encode fn encode(value: json::Value) -> Result<String, errors::Error> Encodes a Value as a YAML document.
from_json fn from_json(source: String) -> Result<String, errors::Error> Converts JSON text to a YAML document.
is_valid fn is_valid(source: String) -> bool Reports whether the text is well-formed YAML.
parse fn parse(source: String) -> Result<json::Value, errors::Error> Parses a YAML document into a Value.
parse_all fn parse_all(source: String) -> Result<Vec<json::Value>, errors::Error> Parses a multi-document YAML stream into a Vec.
to_json fn to_json(source: String) -> Result<String, errors::Error> Converts a YAML document to JSON text.