case class MutableConfig[F[_]](root: String, base: BaseConfig[F]) extends Product with Serializable
Mutable, reloadable, configuration data
- Alphabetic
- By Inheritance
- MutableConfig
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new MutableConfig(root: String, base: BaseConfig[F])
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
add(paths: List[KnobsResource])(implicit F: Effect[F]): F[Unit]
Add additional files to this
MutableConfig
, causing it to be reloaded to add their contents. -
def
addEnv(props: Env)(implicit F: Effect[F]): F[Unit]
Add the properties in the given pure environment to this config.
Add the properties in the given pure environment to this config. Note: If this config is reloaded from source, these additional properties will be lost.
-
def
addGroups(paths: List[(Name, KnobsResource)])(implicit F: Effect[F]): F[Unit]
Add additional files to named groups in this
MutableConfig
, causing it to be reloaded to add their contents. -
def
addMap[V](props: Map[Name, V])(implicit arg0: Valuable[V], F: Effect[F]): F[Unit]
Add the properties in the given
Map
to this config.Add the properties in the given
Map
to this config. The values will be converted toCfgValue
s according to theirValuable
instance. Note: If this config is reloaded from source, these additional properties will be lost. -
def
addStrings(props: Map[Name, String])(implicit F: Effect[F]): F[Unit]
Add the properties in the given
Map
to this config.Add the properties in the given
Map
to this config. TheString
values will be parsed intoCfgValue
s. Note: If this config is reloaded from source, these additional properties will be lost. -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val base: BaseConfig[F]
-
def
changes(p: Pattern)(implicit F: Effect[F], ec: ExecutionContext): Stream[F, (Name, Option[CfgValue])]
A process that produces chages to the configuration properties that match the given pattern
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getEnv(implicit F: Functor[F]): F[Env]
Fetch the
Map
that maps names to values.Fetch the
Map
that maps names to values. Turns the config into a pure value disconnected from the file resources it came from. -
def
immutable(implicit F: Functor[F]): F[Config]
Get an immutable
Config
from of the current state of thisMutableConfig
. -
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
lookup[A](name: Name)(implicit arg0: Configured[A], F: Functor[F]): F[Option[A]]
Look up a name in the
MutableConfig
.Look up a name in the
MutableConfig
. If a binding exists, and the value can be converted to the desired type, return the converted value, otherwiseNone
. -
def
lookupDefault[A](default: A, name: Name)(implicit arg0: Configured[A], F: Functor[F]): F[A]
Look up a name in the
MutableConfig
.Look up a name in the
MutableConfig
. If a binding exists, and the value can be converted to the desired type, return the converted value, otherwise return the default value. -
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()
-
def
pretty(implicit F: Functor[F]): F[String]
Perform a simple dump of a
MutableConfig
to aString
. -
def
reload(implicit F: Effect[F]): F[Unit]
Forcibly reload this
MutableConfig
from sources.Forcibly reload this
MutableConfig
from sources. Throws an exception on error, such as * if files no longer exist or contain errors. If the providedMutableConfig
is asubconfig
, this will reload the entire top-level configuration, not just the local section. Any overridden properties set withaddProperties
will disappear. -
def
require[A](name: Name)(implicit arg0: Configured[A], F: Monad[F]): F[A]
Look up a name in the
MutableConfig
.Look up a name in the
MutableConfig
. If a binding exists, and the value can be converted to the desired type, return the converted value, otherwise throw aKeyError
. - val root: String
-
def
subconfig(g: Name): MutableConfig[F]
Gives a
MutableConfig
corresponding to just a single group of the originalMutableConfig
.Gives a
MutableConfig
corresponding to just a single group of the originalMutableConfig
. The subconfig can be used just like the original. -
def
subscribe(p: Pattern, h: ChangeHandler[F])(implicit F: Apply[F]): F[Unit]
Subscribe to notifications.
Subscribe to notifications. The given handler will be invoked when any change occurs to a configuration property that matches the pattern.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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( ... )
Deprecated Value Members
-
def
display(implicit F: Sync[F]): F[Unit]
Perform a simple dump of a
MutableConfig
to the console.Perform a simple dump of a
MutableConfig
to the console.- Annotations
- @deprecated
- Deprecated
(Since version 2.2) Use
pretty
instead