zio.blocks.config

Members list

Type members

Classlikes

case object BuildInfo

This object was generated by sbt-buildinfo.

This object was generated by sbt-buildinfo.

Attributes

Source
BuildInfo.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
BuildInfo.type
object Config

Entry point for loading typed configuration from a ConfigSource.

Entry point for loading typed configuration from a ConfigSource.

Attributes

Source
Config.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Config.type
trait ConfigDecoder[A]

A typeclass for decoding a value of type A from a ConfigSource rooted at a given key prefix.

A typeclass for decoding a value of type A from a ConfigSource rooted at a given key prefix.

All errors are accumulated (not fail-fast) and returned as a non-empty list of ConfigError.

Attributes

Companion
object
Source
ConfigDecoder.scala
Supertypes
class Object
trait Matchable
class Any
object ConfigDecoder

Attributes

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

Attributes

Companion
class
Source
ConfigDecoderDeriver.scala
Supertypes
class Object
trait Matchable
class Any
Self type
class ConfigDecoderDeriver(val discriminatorKey: String = ...) extends Deriver[ConfigDecoder]

Attributes

Companion
object
Source
ConfigDecoderDeriver.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
sealed trait ConfigDerivationError extends ConfigError

Category: error during schema-driven config derivation.

Category: error during schema-driven config derivation.

Attributes

Source
ConfigError.scala
Supertypes
trait ConfigError
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
object ConfigError

Attributes

Companion
trait
Source
ConfigError.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ConfigError extends NoStackTrace

Base type for all configuration errors.

Base type for all configuration errors.

Errors are partitioned into category traits for structured matching:

Attributes

Companion
object
Source
ConfigError.scala
Supertypes
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
final class ConfigLoadException(val report: String, val errors: ::[ConfigError]) extends RuntimeException

Exception thrown by Config.loadOrThrow when configuration loading fails.

Exception thrown by Config.loadOrThrow when configuration loading fails.

Carries both the formatted multi-line report shown to users and the original non-empty list of accumulated ConfigErrors for programmatic inspection.

Attributes

Source
Config.scala
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed trait ConfigParseError extends ConfigError

Category: value could not be parsed into the expected type.

Category: value could not be parsed into the expected type.

Attributes

Source
ConfigError.scala
Supertypes
trait ConfigError
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class InvalidValue
class ParseError
trait ConfigSource extends FlagSource

A source of configuration key-value pairs.

A source of configuration key-value pairs.

Attributes

Companion
object
Source
ConfigSource.scala
Supertypes
trait FlagSource
class Object
trait Matchable
class Any
Known subtypes
class MapSource
object EnvSource
object SysPropSource
object ConfigSource

Attributes

Companion
trait
Source
ConfigSource.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ConfigSourceError extends ConfigError

Category: problem with the configuration source (missing key, unauthorized, duplicate).

Category: problem with the configuration source (missing key, unauthorized, duplicate).

Attributes

Source
ConfigError.scala
Supertypes
trait ConfigError
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
sealed trait ConfigValidationError extends ConfigError

Category: value was parsed but failed semantic validation.

Category: value was parsed but failed semantic validation.

Attributes

Source
ConfigError.scala
Supertypes
trait ConfigError
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait Displayable[A]

Attributes

Companion
object
Source
Displayable.scala
Supertypes
class Object
trait Matchable
class Any

Attributes

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

Attributes

Source
Displayable.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Displayable
abstract class DynamicFlag[A](default: A, defaultExpression: String)(implicit reader: Reader[A])

A flag whose value is determined by a rollout expression that can be updated at runtime.

A flag whose value is determined by a rollout expression that can be updated at runtime.

Each call to apply evaluates the rollout expression against the provided key/attributes and tracks evaluation counters. Use evaluate for evaluation without counter tracking.

Intended to be extended by Scala object definitions:

 object MyFeature extends DynamicFlag[Boolean](false, "true@beta/50%; false")

Resolution order for initial expression: FlagSource → system property → env variable → constructor default.

Attributes

Companion
object
Source
DynamicFlag.scala
Supertypes
class Object
trait Matchable
class Any
object DynamicFlag

Attributes

Companion
class
Source
DynamicFlag.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object EnvSource extends ConfigSource

Config source backed by environment variables (JVM). Key lookup converts dots to underscores and uppercases: db.host → DB_HOST. A null env var is treated as absent (None). An empty string "" is present (Some).

Config source backed by environment variables (JVM). Key lookup converts dots to underscores and uppercases: db.host → DB_HOST. A null env var is treated as absent (None). An empty string "" is present (Some).

Attributes

Source
PlatformConfigSource.scala
Supertypes
trait ConfigSource
trait FlagSource
class Object
trait Matchable
class Any
Self type
EnvSource.type
object Flag extends Flag

Attributes

Companion
trait
Source
FlagReader.scala
Supertypes
trait Flag
class Object
trait Matchable
class Any
Self type
Flag.type
trait Flag

Global registry and diagnostics helpers for resolved flags.

Global registry and diagnostics helpers for resolved flags.

Attributes

Companion
object
Source
FlagReader.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Flag
sealed abstract class FlagException extends Exception, NoStackTrace

Base class for all flag-related exceptions.

Base class for all flag-related exceptions.

Extends scala.util.control.NoStackTrace so that instances are lightweight and do not capture a stack trace, which is appropriate for flag resolution errors that are diagnosed at startup rather than during request handling.

Concrete subtypes live in FlagException companion:

Attributes

Companion
object
Source
FlagException.scala
Supertypes
trait NoStackTrace
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
object FlagException

Attributes

Companion
class
Source
FlagException.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait FlagSource

A scalar source of flag values.

A scalar source of flag values.

Attributes

Companion
object
Source
FlagSource.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ConfigSource
class MapSource
object EnvSource
object SysPropSource
object FlagSource

Attributes

Companion
trait
Source
FlagSource.scala
Supertypes
class Object
trait Matchable
class Any
Self type
FlagSource.type
object KeyFormat

Attributes

Companion
trait
Source
KeyFormat.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
KeyFormat.type
sealed trait KeyFormat

Supported output formats for source-facing configuration keys.

Supported output formats for source-facing configuration keys.

Attributes

Companion
object
Source
KeyFormat.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CamelCase
object KebabCase
object SnakeCase
trait KeyMapper

Maps source-specific configuration keys to the canonical lower-camel form used by config decoders and wrapper sources, and back again.

Maps source-specific configuration keys to the canonical lower-camel form used by config decoders and wrapper sources, and back again.

For example, a mapper may treat databaseUrl, database_url, and database-url as the same logical key.

Attributes

Companion
object
Source
KeyMapper.scala
Supertypes
class Object
trait Matchable
class Any
object KeyMapper

Attributes

Companion
trait
Source
KeyMapper.scala
Supertypes
class Object
trait Matchable
class Any
Self type
KeyMapper.type
sealed trait Provenance

Describes where a resolved configuration or flag value came from.

Describes where a resolved configuration or flag value came from.

Attributes

Companion
object
Source
Provenance.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Default
class Resolved
object Provenance

Attributes

Companion
trait
Source
Provenance.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Provenance.type
final case class ProvenanceMap[A](value: A, source: ConfigSource)

A decoded configuration value paired with the ConfigSource that produced it, allowing per-key provenance queries.

A decoded configuration value paired with the ConfigSource that produced it, allowing per-key provenance queries.

Attributes

Source
ProvenanceMap.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Rollout

Rollout DSL for selecting values based on path-matching and percentage bucketing.

Rollout DSL for selecting values based on path-matching and percentage bucketing.

Grammar:

 expression = choice { ";" choice }
 choice     = value "@" selector | value
 selector   = path [ "/" percentage ]
 path       = segment { "/" segment }
 segment    = "*" | literal
 percentage = digits "%"

Left-to-right evaluation, first match wins. A bare value (no @) is a catch-all and should appear last; later entries are unreachable.

Attributes

Source
Rollout.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Rollout.type
final class Secret

Attributes

Companion
object
Source
Secret.scala
Supertypes
class Object
trait Matchable
class Any
object Secret

Attributes

Companion
class
Source
Secret.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Secret.type
final case class SourceValue[A](value: A, provenance: Provenance)

Attributes

Source
SourceValue.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
abstract class StaticFlag[A](default: A)(implicit reader: Reader[A], displayable: Displayable[A])

A flag whose value is resolved exactly once at class-load time and never changes.

A flag whose value is resolved exactly once at class-load time and never changes.

Intended to be extended by Scala object definitions:

 object MyFlag extends StaticFlag[Int](42)

Resolution order: FlagSource registry → system property → environment variable → default. Throws at class load on parse/validation failure (fail-fast).

Attributes

Companion
object
Source
StaticFlag.scala
Supertypes
class Object
trait Matchable
class Any
object StaticFlag

Attributes

Companion
class
Source
StaticFlag.scala
Supertypes
class Object
trait Matchable
class Any
Self type
StaticFlag.type
object SysPropSource extends ConfigSource

Config source backed by JVM system properties. Key lookup uses the dot-separated path directly.

Config source backed by JVM system properties. Key lookup uses the dot-separated path directly.

Attributes

Source
PlatformConfigSource.scala
Supertypes
trait ConfigSource
trait FlagSource
class Object
trait Matchable
class Any
Self type

Implicits

Implicits

Attributes

Source
package.scala