Documentation

An UCL object

Parse a String into a UCL, resolving includes, macros, variables...

>>> parseString "{a: [1,2], 🌅: 3min, a: [4]}"
Right (UCLMap (fromList
  [ ("a"      , UCLArray [UCLInt 1, UCLInt 2, UCLInt 4])
  , ("\127749", UCLTime 180s                           )
  ]))

This function is not safe to call on untrusted input: configurations can read files, make http requests, do "billion laughs" attacks, and possibly crash the parser.

Parse a ByteString into a UCL, resolving includes, macros, variables... Note that unicode does not get converted when using fromString. Prefer parseString when working on Strings or literals.

>>> parseByteString $ fromString "{a: [1,2], b: 3min, a: [4]}"
Right (UCLMap (fromList
  [ ("a", UCLArray [UCLInt 1, UCLInt 2, UCLInt 4])
  , ("b", UCLTime 180s                           )
  ]))

This function is not safe to call on untrusted input: configurations can read files, make http requests, do "billion laughs" attacks, and possibly crash the parser.

Parse the contents of a file into a UCL, resolving includes, macros, variables...

This function is not safe to call on untrusted input: configurations can read files, make http requests, do "billion laughs" attacks, and possibly crash the parser.