pureconfig

CoproductHint

trait CoproductHint[T] extends AnyRef

A trait that can be implemented to disambiguate between the different options of a coproduct or sealed family.

T

the type of the coproduct or sealed family for which this hint applies

Annotations
@deprecated
Deprecated

(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CoproductHint
  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(cv: ConfigValue, name: String): Either[ConfigReaderFailures, Option[ConfigValue]]

    Given a ConfigValue for the sealed family, disambiguate and extract the ConfigValue associated to the implementation for the given class or coproduct option name.

    Given a ConfigValue for the sealed family, disambiguate and extract the ConfigValue associated to the implementation for the given class or coproduct option name.

    If cv is a config for the given class name, this method returns Right(Some(v)), where v is the config related to the specific class (possibly the same as cv). If it determines that cv is a config for a different class, it returns Right(None). If cv is missing information for disambiguation or has a wrong type, a Left containing a Failure is returned.

    cv

    the ConfigValue of the sealed family

    name

    the name of the class or coproduct option to try

    returns

    a Either[ConfigReaderFailure, Option[ConfigValue]] as defined above.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig

  2. abstract def to(cv: ConfigValue, name: String): Either[ConfigReaderFailures, ConfigValue]

    Given the ConfigValue for a specific class or coproduct option, encode disambiguation information and return a config for the sealed family or coproduct.

    Given the ConfigValue for a specific class or coproduct option, encode disambiguation information and return a config for the sealed family or coproduct.

    cv

    the ConfigValue of the class or coproduct option

    name

    the name of the class or coproduct option

    returns

    the config for the sealed family or coproduct wrapped in a Right, or a Left with the failure if some error occurred.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig

  3. abstract def tryNextOnFail(name: String): Boolean

    Defines what to do if from returns Success(Some(_)) for a class or coproduct option, but its ConfigConvert fails to deserialize the config.

    Defines what to do if from returns Success(Some(_)) for a class or coproduct option, but its ConfigConvert fails to deserialize the config.

    name

    the name of the class or coproduct option

    returns

    true if the next class or coproduct option should be tried, false otherwise.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig

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