io.circe.config

parser

object parser extends Parser

Utilities for parsing com.typesafe.config.Config sources to io.circe.Json as well as decoding to a specific type.

Source
parser.scala
Example: 

  1. scala> import com.typesafe.config.ConfigFactory
scala> import io.circe.config.parser
scala> val config = ConfigFactory.parseString("server { host = localhost, port = 8080 }")

scala> val json: Either[io.circe.ParsingFailure, io.circe.Json] = parser.parse(config)
scala> json.right.get.noSpaces
res0: String = {"server":{"port":8080,"host":"localhost"}}

scala> import io.circe.generic.auto._
scala> case class ServerSettings(host: String, port: Int)
scala> parser.decode[ServerSettings](config.getConfig("server"))
res1: Either[io.circe.Error, ServerSettings] = Right(ServerSettings(localhost,8080))
See also

syntax.configDecoder for how to map io.circe.Json to com.typesafe.config.Config

Linear Supertypes
Parser, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. parser
  2. Parser
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def decode[A](config: Config)(implicit arg0: Decoder[A]): Either[Error, A]

  9. final def decode[A](input: String)(implicit arg0: Decoder[A]): Either[Error, A]

    Definition Classes
    Parser

  10. final def decodeAccumulating[A](config: Config)(implicit arg0: Decoder[A]): ValidatedNel[Error, A]

  11. final def decodeAccumulating[A](input: String)(implicit arg0: Decoder[A]): ValidatedNel[Error, A]

    Definition Classes
    Parser

  12. final def decodeFile[A](file: File)(implicit arg0: Decoder[A]): Either[Error, A]

  13. final def decodeFileAccumulating[A](file: File)(implicit arg0: Decoder[A]): ValidatedNel[Error, A]

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. final def finishDecode[A](input: Either[ParsingFailure, Json])(implicit decoder: Decoder[A]): Either[Error, A]

    Attributes
    protected[this]
    Definition Classes
    Parser

  18. final def finishDecodeAccumulating[A](input: Either[ParsingFailure, Json])(implicit decoder: Decoder[A]): ValidatedNel[Error, A]

    Attributes
    protected[this]
    Definition Classes
    Parser

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. final def parse(input: String): Either[ParsingFailure, Json]

    Definition Classes
    parser → Parser

  26. final def parse(config: Config): Either[ParsingFailure, Json]

  27. final def parseFile(file: File): Either[ParsingFailure, Json]

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  29. def toString(): String

    Definition Classes
    AnyRef → Any

  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Parser

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped