Ciris
v3.15.2
API
Generated with
Licensed under the MIT License.
Licensed under the MIT License.
Ciris/ciris/ConfigKey

ConfigKey

ciris.ConfigKey
See theConfigKey companion class
object ConfigKey

Attributes

Companion
class
Source
ConfigKey.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
ConfigKey.type

Members list

Grouped members

Creating Instances

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

Returns a new ConfigKey with the specified description.

Returns a new ConfigKey with the specified description.

Attributes

Source
ConfigKey.scala
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
Source
ConfigKey.scala
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)
Source
ConfigKeyRuntimePlatform.scala
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
Source
ConfigKey.scala
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
Source
ConfigKey.scala

Type Class Instances

final implicit val configKeyEq: Eq[ConfigKey]

Attributes

Source
ConfigKey.scala
final implicit val configKeyShow: Show[ConfigKey]

Attributes

Source
ConfigKey.scala
Generated with
Licensed under the MIT License.
Licensed under the MIT License.