pureconfig

ConfigConvert

trait ConfigConvert[T] extends AnyRef

Trait for conversion between T and RawConfig where T is a "complex" type. For "simple" types have a look at StringConvert

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

Abstract Value Members

  1. abstract def from(config: RawConfig, namespace: String): Try[T]

    Convert the given configuration into an instance of T if possible

    Convert the given configuration into an instance of T if possible

    config

    The configuration from which load the config

    namespace

    The base namespace to use for the conversion. This should be used as base for the name of the fields of T. For instance, given a case class Foo(i: Int) and a configuration conf = Map("foo.i", "1"), then from(conf, "foo") will return Success(Foo(1)) while from(conf, "") will return Failure

    returns

    Success of T if the conversion is possible, Failure with the problem if the conversion is not

  2. abstract def to(t: T, namespace: String): RawConfig

    Converts a type T to a RawConfig using the namespace as base namespace.

    Converts a type T to a RawConfig using the namespace as base namespace.

    t

    The instance of T to convert

    namespace

    The base namespace. For instance, given case class Foo(i: Int), then to(Foo(2), "base.namespace") will return Map("base.namespace.i", "2")

    returns

    The RawConfig obtained from the T instance

Concrete 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 eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  18. def toString(): String

    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped