Packages

trait CoproductHint[A] extends AnyRef

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

A

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

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

Abstract Value Members

  1. abstract def from(cursor: ConfigCursor, options: Seq[String]): Result[Action]

    Given a ConfigCursor for the sealed family, disambiguate and return what should be performed when trying to read one of the provided coproduct options.

    Given a ConfigCursor for the sealed family, disambiguate and return what should be performed when trying to read one of the provided coproduct options. This method can decide either to:

    This method can return a Left if the hint fails to produce a valid CoproductHint.Action.

    cursor

    a ConfigCursor at the sealed family option

    options

    the names of the coproduct options for the given type

    returns

    a ConfigReader.Result of CoproductHint.Action as defined above.

  2. abstract def to(value: ConfigValue, name: String): 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.

    value

    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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped