machinespir.it.jig

Members list

Type members

Classlikes

trait ConfigCodec[A]

Typeclass that combines both reading and writing capabilities for a type A.

Typeclass that combines both reading and writing capabilities for a type A.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ConfigCodecImpl[A]
object ConfigCodec

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class ConfigEntryError(msg: String, path: List[ConfigPath]) extends Exception, NoStackTrace

A config error that never captures stack traces.

A config error that never captures stack traces.

Attributes

Supertypes
trait Product
trait Equals
trait NoStackTrace
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case class ConfigError(msg: String, errors: List[ConfigEntryError], cause: Throwable) extends Exception

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
enum ConfigPath

Represents a path element in the config structure

Represents a path element in the config structure

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConfigPath

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ConfigPath.type
trait ConfigReader[A]

Typeclass for reading an A from a ConfigValue, returning ReadResult[A].

Typeclass for reading an A from a ConfigValue, returning ReadResult[A].

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ConfigSumReader[A]
Show all
object ConfigReader

Derivation helpers for reading.

Derivation helpers for reading.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait ConfigWriter[A]

Typeclass for writing an A value to a ConfigValue.

Typeclass for writing an A value to a ConfigValue.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ConfigSumWriter[A]
Show all
object ConfigWriter

Derivation helpers for writing.

Derivation helpers for writing.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait NonEmptyList[+A]

A simple non-empty list implementation

A simple non-empty list implementation

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object NonEmptyList

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ReadFailed(errors: NonEmptyList[ConfigEntryError]) extends ReadResult[Nothing]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ReadResult[Nothing]
class Object
trait Matchable
class Any
Show all
sealed trait ReadResult[+A]

Represents the result of reading a config value

Represents the result of reading a config value

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ReadFailed
class ReadSucceeded[A]
object ReadResult

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ReadResult.type
case class ReadSucceeded[+A](value: A) extends ReadResult[A]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ReadResult[A]
class Object
trait Matchable
class Any
Show all
case class comment(text: String) extends StaticAnnotation

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
object read

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
read.type
object write

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
write.type

Value members

Concrete fields

val JigRenderOptions: ConfigRenderOptions

Extensions

Extensions

extension [A](nel: NonEmptyList[A])
def mkString(sep: String): String
def mkString(prefix: String, sep: String, suffix: String): String

Exports

Defined exports

final type Config = Config
Exported from config
final val ConfigFactory: ConfigFactory
Exported from config
final type ConfigFactory = ConfigFactory
Exported from config
final val ConfigRenderOptions: ConfigRenderOptions
Exported from config
final type ConfigRenderOptions = ConfigRenderOptions
Exported from config