Trait/Object

pureconfig

ConfigSource

Related Docs: object ConfigSource | package pureconfig

Permalink

trait ConfigSource extends AnyRef

A representation of a source from which ConfigValues can be loaded, such as a file or a URL.

A source allows users to load configs from this source as any type for which a ConfigReader is available. Raw configs can also be retrieved as a ConfigValue, a ConfigCursor or a FluentConfigCursor. Before using any of the loading methods described, Users can opt to focus on a specific part of a config by specifying a namespace.

All config loading methods are lazy and defer resolution of references until needed.

Linear Supertypes
AnyRef, Any
Known Subclasses
ConfigObjectSource
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigSource
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def value(): Result[ConfigValue]

    Permalink

    Retrieves a ConfigValue from this source.

    Retrieves a ConfigValue from this source. This forces the config to be resolved, if needed.

    returns

    a ConfigValue retrieved from this source.

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def at(namespace: String): ConfigSource

    Permalink

    Navigates through the config to focus on a namespace.

    Navigates through the config to focus on a namespace.

    namespace

    the namespace to focus on

    returns

    a new ConfigSource focused on the given namespace.

  6. def clone(): AnyRef

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

  7. def cursor(): Result[ConfigCursor]

    Permalink

    Returns a cursor for a ConfigValue retrieved from this source.

    Returns a cursor for a ConfigValue retrieved from this source.

    returns

    a cursor for a ConfigValue retrieved from this source.

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

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

  11. def fluentCursor(): FluentConfigCursor

    Permalink

    Returns a fluent cursor for a ConfigValue retrieved from this source.

    Returns a fluent cursor for a ConfigValue retrieved from this source.

    returns

    a fluent cursor for a ConfigValue retrieved from this source.

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

    Permalink
    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  15. final def load[A](implicit reader: Derivation[ConfigReader[A]]): Result[A]

    Permalink

    Loads a configuration of type A from this source.

    Loads a configuration of type A from this source.

    A

    the type of the config to be loaded

    returns

    A Right with the configuration if it is possible to create an instance of type A from this source, a Failure with details on why it isn't possible otherwise

  16. final def loadOrThrow[A](implicit arg0: ClassTag[A], reader: Derivation[ConfigReader[A]]): A

    Permalink

    Loads a configuration of type A from this source.

    Loads a configuration of type A from this source. If it is not possible to create an instance of A, this method throws a ConfigReaderException.

    A

    the type of the config to be loaded

    returns

    The configuration of type A loaded from this source.

    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped