A class of values that can be encoded to RON format.

There are several ways to define an instance:

1. By producing a Value by hand
2. By using toRonGeneric
3. By DerivingVia extension and using RonWith

When using the second option, the encoding parameters are specified with RonSettings. With the third option, the same parameters are specified by a list of settings found in Deriving.

The default implementation uses generic encoding with laxRonSettings. You can use other settings like this:

     instance ToRon MyType where
         toRon = toRonGeneric strictRonSettings
             { encodeFlags = RonFlags
                 { implicitSome = True
                 , skipSingleConstructor = True
                 }
             }

Or like this:

     deriving via (RonWith '[UseStrict, EncodeWith SkipSingleConstructor, EncodeWith ImplicitSome])
         instance ToRon MyType

A class of values that can be restored from RON format

There are several ways to define an instance:

1. By deconstructing a Value by hand and producing a value of your type
2. By using fromRonGeneric
3. By DerivingVia extension and using RonWith

The default implementation uses generic decoding with laxRonSettings. You can use other settings like this:

     instance FromRon MyType where
         fromRon = fromRonGeneric strictRonSettings
             { decodeFlags = RonFlags
                 { implicitSome = True
                 , skipSingleConstructor = True
                 }
             }

Or like this:

     deriving via (RonWith '[UseStrict, DecodeWith SkipSingleConstructor, DecodeWith ImplicitSome])
         instance FromRon MyType

When decoding from ron, this type is used to indicate decode failure. During decoding, multiple failures may be concatenated with a semicolon, and for some functions the string will be thrown with DecodeError. When implementing your own decoding functions, you should put short one-sentence error descriptions.

For the next major release, we plan to replace it with a better mechanism that reports error locations and supports long-form content.

Settings for use with Generic RON encoding/decoding

Part of RonSettings that applies to both encoding and decoding, and separately

Values are expected to exactly conform: all fields should have the same name, all constructors should be present, no Some omission

Relaxes strictRonSettings on constructor omission and implicitSome when decoding, but encodes in the same strict way

Encode ron using Generic instance and provided RonSettings.

With generic encoding sums are turned into sums, records into records, and multi-param constructors into tuples.

Decode ron using Generic instance and provided RonSettings

With generic encoding sums are turned into sums, records into records, and multi-param constructors into tuples.

Internal class for converting to Ron. You might need it if you're writing you own generic combinators

Internal class for converting from Ron. You might need it if you're writing you own generic combinators