ConfigKey

ciris.ConfigKey$
See theConfigKey companion class
object ConfigKey

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Value members

Concrete methods

final def apply(description: => String): ConfigKey

Returns a new ConfigKey with the specified description.

Returns a new ConfigKey with the specified description.

Attributes

final def env(name: String): ConfigKey

Returns a new ConfigKey for the specified environment variable.

Returns a new ConfigKey for the specified environment variable.

Attributes

Example:
scala> val apiKey = ConfigKey.env("API_KEY")
apiKey: ConfigKey = ConfigKey(environment variable API_KEY)
scala> apiKey.description
res0: String = environment variable API_KEY
final def prop(name: String): ConfigKey

Returns a new ConfigKey for the specified system property.

Returns a new ConfigKey for the specified system property.

Attributes

Example:
scala> val apiKey = ConfigKey.prop("api.key")
apiKey: ConfigKey = ConfigKey(system property api.key)
scala> apiKey.description
res0: String = system property api.key
final def unapply(key: ConfigKey): Some[String]

Returns the description for the specified ConfigKey.

Returns the description for the specified ConfigKey.

This function enables pattern matching on ConfigKeys.

Attributes

Example:
scala> val apiKey = ConfigKey.env("API_KEY")
apiKey: ConfigKey = ConfigKey(environment variable API_KEY)
scala> apiKey match { case ConfigKey(description) => description }
res0: String = environment variable API_KEY

Inherited methods

final def file(path: Path, charset: Charset): ConfigKey

Returns a new ConfigKey for the specified path and charset.

Returns a new ConfigKey for the specified path and charset.

Attributes

Inherited from:
ConfigKeyRuntimePlatform (hidden)

Implicits

Implicits

final implicit val configKeyEq: Eq[ConfigKey]

Attributes

final implicit val configKeyShow: Show[ConfigKey]

Attributes