object ConfigReader extends BasicReaders with DerivedReaders
Provides methods to create ConfigReader instances.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- ConfigReader
- DerivedReaders
- DerivedReaders1
- BasicReaders
- TypesafeConfigReaders
- NumericReaders
- DurationReaders
- JavaTimeReaders
- RegexReaders
- UriAndPathReaders
- JavaEnumReader
- PrimitiveReaders
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
-
class
OptionConfigReader[T] extends ConfigReader[Option[T]] with AllowMissingKey
- Definition Classes
- DerivedReaders1
-
trait
WrappedDefaultValue[Wrapped, SubRepr <: HList, DefaultRepr <: HList] extends AnyRef
- Attributes
- protected[pureconfig]
- Definition Classes
- DerivedReaders1
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
- def apply[A](implicit reader: ConfigReader[A]): ConfigReader[A]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
implicit
val
booleanConfigReader: ConfigReader[Boolean]
- Definition Classes
- PrimitiveReaders
-
implicit final
def
cNilConfigReader[Wrapped]: WrappedConfigReader[Wrapped, CNil]
- Definition Classes
- DerivedReaders1
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
implicit
val
configConfigReader: ConfigReader[Config]
- Definition Classes
- TypesafeConfigReaders
-
implicit
val
configListConfigReader: ConfigReader[ConfigList]
- Definition Classes
- TypesafeConfigReaders
-
implicit
val
configObjectConfigReader: ConfigReader[ConfigObject]
- Definition Classes
- TypesafeConfigReaders
-
implicit
val
configValueConfigReader: ConfigReader[ConfigValue]
- Definition Classes
- TypesafeConfigReaders
-
implicit final
def
coproductConfigReader[Wrapped, Name <: Symbol, V, T <: Coproduct](implicit coproductHint: CoproductHint[Wrapped], vName: Aux[Name], vFieldConvert: Derivation[Lazy[ConfigReader[V]]], tConfigReader: Lazy[WrappedConfigReader[Wrapped, T]]): WrappedConfigReader[Wrapped, :+:[FieldType[Name, V], T]]
- Definition Classes
- DerivedReaders1
-
implicit
def
deriveAnyVal[T, U](implicit ev: <:<[T, AnyVal], generic: Generic[T], unwrapped: Aux[T, U], reader: ConfigReader[U]): ConfigReader[T]
- Definition Classes
- DerivedReaders
-
implicit final
def
deriveCoproductInstance[F, Repr <: Coproduct](implicit gen: Aux[F, Repr], cc: Lazy[WrappedConfigReader[F, Repr]]): ConfigReader[F]
- Definition Classes
- DerivedReaders1
-
implicit
def
deriveMap[T](implicit reader: Derivation[Lazy[ConfigReader[T]]]): ConfigReader[Map[String, T]]
- Definition Classes
- DerivedReaders1
-
implicit
def
deriveOption[T](implicit conv: Derivation[Lazy[ConfigReader[T]]]): OptionConfigReader[T]
- Definition Classes
- DerivedReaders1
-
implicit final
def
deriveProductInstance[F, Repr <: HList, DefaultRepr <: HList](implicit gen: Aux[F, Repr], default: Aux[F, DefaultRepr], cc: Lazy[WrappedDefaultValue[F, Repr, DefaultRepr]]): ConfigReader[F]
- Definition Classes
- DerivedReaders1
-
implicit
def
deriveTraversable[T, F[T] <: TraversableOnce[T]](implicit configConvert: Derivation[Lazy[ConfigReader[T]]], cbf: CanBuildFrom[F[T], T, F[T]]): ConfigReader[F[T]]
- Definition Classes
- DerivedReaders1
-
implicit
def
deriveTupleInstance[F, Repr <: HList, LRepr <: HList, DefaultRepr <: HList](implicit arg0: IsTuple[F], g: Aux[F, Repr], gcr: ConfigReader[Repr], lg: Aux[F, LRepr], default: Aux[F, DefaultRepr], pr: WrappedDefaultValue[F, LRepr, DefaultRepr]): ConfigReader[F]
- Definition Classes
- DerivedReaders
-
implicit
val
doubleConfigReader: ConfigReader[Double]
- Definition Classes
- PrimitiveReaders
-
implicit
val
durationConfigReader: ConfigReader[Duration]
- Definition Classes
- DurationReaders
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
implicit
val
fileConfigReader: ConfigReader[File]
- Definition Classes
- UriAndPathReaders
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
implicit
val
finiteDurationConfigReader: ConfigReader[FiniteDuration]
- Definition Classes
- DurationReaders
-
implicit
val
floatConfigReader: ConfigReader[Float]
- Definition Classes
- PrimitiveReaders
-
def
fromCursor[A](fromF: (ConfigCursor) ⇒ Either[ConfigReaderFailures, A]): ConfigReader[A]
Creates a
ConfigReaderfrom a function reading aConfigCursor.Creates a
ConfigReaderfrom a function reading aConfigCursor.- A
the type of the objects readable by the returned reader
- fromF
the function used to read config cursors to values
- returns
a
ConfigReaderfor reading objects of typeAusingfromF.
-
def
fromFunction[A](fromF: (ConfigValue) ⇒ Either[ConfigReaderFailures, A]): ConfigReader[A]
Creates a
ConfigReaderfrom a function.Creates a
ConfigReaderfrom a function.- A
the type of the objects readable by the returned reader
- fromF
the function used to read configs to values
- returns
a
ConfigReaderfor reading objects of typeAusingfromF.
- def fromNonEmptyString[A](fromF: (String) ⇒ Either[FailureReason, A])(implicit ct: ClassTag[A]): ConfigReader[A]
- def fromNonEmptyStringOpt[A](fromF: (String) ⇒ Option[A])(implicit ct: ClassTag[A]): ConfigReader[A]
- def fromNonEmptyStringTry[A](fromF: (String) ⇒ Try[A])(implicit ct: ClassTag[A]): ConfigReader[A]
- def fromString[A](fromF: (String) ⇒ Either[FailureReason, A]): ConfigReader[A]
- def fromStringOpt[A](fromF: (String) ⇒ Option[A])(implicit ct: ClassTag[A]): ConfigReader[A]
- def fromStringTry[A](fromF: (String) ⇒ Try[A])(implicit ct: ClassTag[A]): ConfigReader[A]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
implicit final
def
hConsConfigReader[H, T <: HList](implicit hr: Derivation[Lazy[ConfigReader[H]]], tr: Lazy[ConfigReader[T]], tl: HKernelAux[T]): ConfigReader[::[H, T]]
- Definition Classes
- DerivedReaders1
-
implicit final
lazy val
hNilConfigReader: ConfigReader[HNil]
- Definition Classes
- DerivedReaders1
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
implicit
val
instantConfigReader: ConfigReader[Instant]
- Definition Classes
- JavaTimeReaders
-
implicit
val
intConfigReader: ConfigReader[Int]
- Definition Classes
- PrimitiveReaders
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
implicit
val
javaBigDecimalReader: ConfigReader[BigDecimal]
- Definition Classes
- NumericReaders
-
implicit
val
javaBigIntegerReader: ConfigReader[BigInteger]
- Definition Classes
- NumericReaders
-
implicit
val
javaDurationConfigReader: ConfigReader[Duration]
- Definition Classes
- JavaTimeReaders
-
implicit
def
javaEnumReader[T <: Enum[T]](implicit tag: ClassTag[T]): ConfigReader[T]
- Definition Classes
- JavaEnumReader
-
implicit final
def
labelledHConsConfigReader[Wrapped, K <: Symbol, V, T <: HList, U <: HList](implicit key: Aux[K], vFieldReader: Derivation[Lazy[ConfigReader[V]]], tConfigReader: Lazy[WrappedDefaultValue[Wrapped, T, U]], hint: ProductHint[Wrapped]): WrappedDefaultValue[Wrapped, ::[FieldType[K, V], T], ::[Option[V], U]]
- Definition Classes
- DerivedReaders1
-
implicit final
def
labelledHNilConfigReader[Wrapped](implicit hint: ProductHint[Wrapped]): WrappedDefaultValue[Wrapped, HNil, HNil]
- Definition Classes
- DerivedReaders1
-
implicit
val
longConfigReader: ConfigReader[Long]
- Definition Classes
- PrimitiveReaders
-
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()
-
implicit
val
pathConfigReader: ConfigReader[Path]
- Definition Classes
- UriAndPathReaders
-
implicit
val
patternReader: ConfigReader[Pattern]
- Definition Classes
- RegexReaders
-
implicit
val
periodConfigReader: ConfigReader[Period]
- Definition Classes
- JavaTimeReaders
-
implicit
val
regexReader: ConfigReader[Regex]
- Definition Classes
- RegexReaders
-
implicit
val
scalaBigDecimalReader: ConfigReader[BigDecimal]
- Definition Classes
- NumericReaders
-
implicit
val
scalaBigIntReader: ConfigReader[BigInt]
- Definition Classes
- NumericReaders
-
implicit
val
shortConfigReader: ConfigReader[Short]
- Definition Classes
- PrimitiveReaders
-
implicit
val
stringConfigReader: ConfigReader[String]
- Definition Classes
- PrimitiveReaders
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
implicit
val
uriConfigReader: ConfigReader[URI]
- Definition Classes
- UriAndPathReaders
-
implicit
val
urlConfigReader: ConfigReader[URL]
- Definition Classes
- UriAndPathReaders
-
implicit
val
uuidConfigReader: ConfigReader[UUID]
- Definition Classes
- UriAndPathReaders
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
implicit
val
yearConfigReader: ConfigReader[Year]
- Definition Classes
- JavaTimeReaders
-
implicit
val
zoneIdConfigReader: ConfigReader[ZoneId]
- Definition Classes
- JavaTimeReaders
-
implicit
val
zoneOffsetConfigReader: ConfigReader[ZoneOffset]
- Definition Classes
- JavaTimeReaders