Namespace: joker.yaml

v1.0

Contents

• Summary
• Index
• Constants
• Variables
• Functions, Macros, and Special Forms

Summary

Encodes Joker values to YAML and decodes YAML strings into Joker values.

Index

• read-string
• write-string

Constants

Constants are variables with :const true in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.

(None.)

Variables

(None.)

Functions, Macros, and Special Forms

• read-string

  Function v1.0

  (read-string s)
  

  Parses YAML string s and returns the corresponding Joker value.
  
  YAML mappings become maps, sequences become vectors, scalars become their
  nearest Joker values, and null becomes nil. Throws Error when s is invalid
  YAML.

• write-string

  Function v1.0

  (write-string v)
  

  Returns the YAML encoding of v.
  
  Keywords are encoded without their leading colon, map keys are converted to
  strings, and vectors become YAML sequences. Throws Error when v cannot be
  encoded.