Autodocodec.Yaml

Encoding and decoding Yaml

encodeYamlViaCodec :: HasCodec a => a -> ByteString

Encode a value as a Yaml ByteString via its type's codec.

eitherDecodeYamlViaCodec :: HasCodec a => ByteString -> Either ParseException a

Parse a Yaml ByteString using a type's codec.

Reading Yaml Files

readYamlConfigFile :: HasCodec a => Path r File -> IO (Maybe a)

Helper function to read a yaml file for a type in HasCodec

This will output a colourful yaml schema if parsing fails.

readFirstYamlConfigFile :: forall a r. HasCodec a => [Path r File] -> IO (Maybe a)

Helper function to read the first in a list of yaml files for a type is HasCodec

This will output a colourful yaml schema if parsing fails.

Producing a Yaml schema

renderColouredSchemaViaCodec :: forall a. HasCodec a => Text

Render a human-readable schema for a type's codec, in colour.

renderColouredSchemaVia :: ValueCodec input output -> Text

Render a human-readable schema for a given codec, in colour.

renderPlainSchemaViaCodec :: forall a. HasCodec a => Text

Render a human-readable schema for a type's codec, without colour.

renderPlainSchemaVia :: ValueCodec input output -> Text

Render a human-readable schema for a given codec, without colour.

schemaChunksViaCodec :: forall a. HasCodec a => [Chunk]

Produce potentially-coloured Chunks for a human-readable schema for a type's codec.

schemaChunksVia :: ValueCodec input output -> [Chunk]

Produce potentially-coloured Chunks for a human-readable schema for a given codec.

jsonSchemaChunks :: JSONSchema -> [Chunk]

Render a JSONSchema as Chunks

Instantiating ToYaml

toYamlViaCodec :: HasCodec a => a -> YamlBuilder

Implement toYaml using a type's codec

toYamlVia :: ValueCodec a void -> a -> YamlBuilder

Implement toYaml using a given codec

To makes sure we definitely export everything.

module Autodocodec.Yaml.Schema

module Autodocodec.Yaml.IO

module Autodocodec.Yaml.Encode