class FirstSuccessCoproductHint[A] extends CoproductHint[A]
Hint where all coproduct options are tried in order. from will choose the first option able to deserialize
the config without errors, while to will write the config as is, with no disambiguation information.
- Alphabetic
- By Inheritance
- FirstSuccessCoproductHint
- CoproductHint
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new FirstSuccessCoproductHint()
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def from(cursor: ConfigCursor, options: Seq[String]): Result[Action]
Given a
ConfigCursorfor the sealed family, disambiguate and return what should be performed when trying to read one of the provided coproduct options.Given a
ConfigCursorfor 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:- use the
ConfigCursorwith a single option (CoproductHint.Use); - or attempt different options in a given order (CoproductHint.Attempt).
This method can return a
Leftif the hint fails to produce a valid CoproductHint.Action.- cursor
a
ConfigCursorat the sealed family option- options
the names of the coproduct options for the given type
- returns
a
ConfigReader.Resultof CoproductHint.Action as defined above.
- Definition Classes
- FirstSuccessCoproductHint → CoproductHint
- use the
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def to(value: ConfigValue, name: String): ConfigValue
Given the
ConfigValuefor a specific class or coproduct option, encode disambiguation information and return a config for the sealed family or coproduct.Given the
ConfigValuefor a specific class or coproduct option, encode disambiguation information and return a config for the sealed family or coproduct.- value
the
ConfigValueof 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 aLeftwith the failure if some error occurred.
- Definition Classes
- FirstSuccessCoproductHint → CoproductHint
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()