Type Members

1.  trait CombinedDecoderInstances extends AnyRef
2.  trait CombinedEncoderInstances extends AnyRef
3.  trait CombinedRefute[A] extends AnyRef
4.  trait DataSource extends AnyRef
5.  trait Decode extends AnyRef
6.  trait DecodePartiallyApplied[F[_], A, S, D, I] extends AnyRef
7.  trait Decoder[F[_], S, A, I] extends AnyRef

   Reads value A from input I, wrapping result in functor F.

   Reads value A from input I, wrapping result in functor F.

   F

   Functor in which to wrap return type

   S

   Settings to use when decoding

   A

   Decoded type

   I

   Input data

8.  trait DecoderRefute[T, S, D] extends AnyRef
9.  trait DerivedDecoderInstances extends AnyRef
10.  trait DerivedEncoderInstances extends AnyRef
11.  trait Encode extends AnyRef
12.  trait EncodePartiallyApplied[F[_], S, E, O] extends AnyRef
13.  trait Encoder[F[_], S, A, O] extends AnyRef

    Encode value A into data source O, wrapping result in functor F

    Encode value A into data source O, wrapping result in functor F

    F

    functor to wrap output

    S

    settings for encoding

    A

    value to encode

    O

    output data

14.  trait EncoderRefute[T, S, D] extends AnyRef
15.  trait ExtruderErrors[F[_]] extends AnyRef

    Church encoding of errors which Extruder may raise for functor type F.

    Church encoding of errors which Extruder may raise for functor type F.

    Implicit instances may be derived from a cats ApplicativeError[F, Throwable]

    F

    functor type

16.  trait GenericDecoderInstances extends AnyRef
17.  trait GenericEncoderInstances extends AnyRef
18.  trait HasValue[F[_], S, I] extends AnyRef

    Discovers if data source I has a certain value at a path.

    Discovers if data source I has a certain value at a path.

    Used when looking up optional values. Instances may be automatically derived from StringReader instances.

    F

    functor in which to wrap boolean result

    S

    settings to use when looking up value

    I

    input data

19.  trait LoadInput[F[_], I] extends AnyRef

    Loads input data I with some side effect represented by functor F.

    Loads input data I with some side effect represented by functor F.

    F

    functor in which to wrap the result

    I

    input data type

20.  trait LowPriorityLoadInput extends AnyRef
21.  trait LowPriorityShows extends AnyRef
22.  trait LowPriorityTransform extends AnyRef
23.  trait MapDecoderInstances extends OptionSelector
24.  trait MapEncoderInstances extends AnyRef
25.  trait MultiParser[F[_], A] extends AnyRef

    Parse A from multiple string values

    Parse A from multiple string values

    Uses a lookup function when parsing to retrieve multiple string values from a data source. If no values could be looked up an empty option will be returned. If values could be looked up but validation failed errors will be collected on the left side of a ValidatedNel instance. If validation was successful then the value A will be returned on the right side of a ValidatedNel.

    Implicit DeocderT instances will be constructed from every MultiParser instance where a StringReader instance also exists.

    F

    Functor in which to wrap the result

26.  trait MultiShow[A] extends AnyRef

    Converts value A into a Map[String, String] where each element in the map represents encoded parameters of A.

    Converts value A into a Map[String, String] where each element in the map represents encoded parameters of A.

    Implicit EncoderT instances will be constructed from every MultiShow instance where a StringWriter instance also exists.

    A

    input value to be converted into a Map[String, String]

27.  trait OptionSelector extends AnyRef
28.  trait Parser[A] extends AnyRef

    Parse value A from a string

    Parse value A from a string

    Implicit DeocderT instances will be constructed from every Parser instance where a StringReader instance also exists.

    A

    output value

29.  trait ParserDecoderInstances extends Resolve
30.  trait Parsers extends AnyRef
31.  trait Prune[F[_], S, I] extends AnyRef

    Used to constrain a data source I to a certain path, returning the constrained data source with a copy of all of its keys.

    Used to constrain a data source I to a certain path, returning the constrained data source with a copy of all of its keys.

    Used in some data sources when decoding a map

    F

    Functor in which to wrap the result

    S

    Settings to use when looking up values

    I

    Data to read from and return

32.  trait Resolve extends OptionSelector
33.  trait Settings extends AnyRef
34.  trait Show[A] extends AnyRef

    Encode value A as a string

    Encode value A as a string

    Implicit EncoderT instances will be constructed from every Shows instance where a StringWriter instance also exists.

    A

    value to encode

35.  trait ShowEncoderInstances extends AnyRef
36.  trait Shows extends LowPriorityShows
37.  trait StringReader[F[_], S, I] extends AnyRef

    Read a string from input I at a path, returning an optional string wrapped in functor F.

    Read a string from input I at a path, returning an optional string wrapped in functor F.

    Used with Parser or MultiParser instances to automatically derive DecoderT instances.

    F

    functor to wrap the result in

    S

    settings to use when looking up

    I

    input data to read from

38.  trait StringWriter[F[_], S, O] extends AnyRef

    Write a string to output data O wrapped in functor F.

39.  trait Transform[F[_], S, I, O] extends AnyRef

    Transforms encoded data or data to be decoded.

    Transforms encoded data or data to be decoded. Very similar to a Kleisli composition, can even be constructed from such a composition.

    Takes input data I and transforms it into output data O, wrapping the result in functor F using a provided namespace and settings.

    F

    functor to wrap the result in

    S

    settings used when transforming

    I

    input data

    O

    output data

40.  trait ValidationErrorsToThrowable extends AnyRef

    Converts a single or collection of validation errors to a throwable

    Converts a single or collection of validation errors to a throwable

    May be used with cats-effect or when performing an unsafe invocation