PPS-22-srs
API
Generated with
PPS-22-srs/io.github.srs/io.github.srs.config

io.github.srs.config

package io.github.srs.config

Members list

Packages

package io.github.srs.config.yaml

Type members

Classlikes

enum ConfigError

An enumeration of possible configuration errors that can occur during the decoding of configuration values.

An enumeration of possible configuration errors that can occur during the decoding of configuration values.

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait ConfigManager[F[_]]

A trait for managing simulation configurations.

A trait for managing simulation configurations.

Type parameters

F

the effect type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class SimulationConfig[E <: EnvironmentParameters](simulation: Simulation, environment: E)

A configuration for a simulation, containing the simulation and its environment.

A configuration for a simulation, containing the simulation and its environment.

Type parameters

E

the type of environment parameters

Value parameters

environment

the environment in which the simulation runs

simulation

the simulation instance

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class YamlConfigManager[F[_]](path: Path)(using evidence$1: Files[F], evidence$2: Sync[F]) extends ConfigManager[F]

A configuration manager that reads a YAML file from the specified path and provides methods to save a yaml configuration.

A configuration manager that reads a YAML file from the specified path and provides methods to save a yaml configuration.

Type parameters

F

the effect type

Value parameters

path

the path to the YAML configuration file

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ConfigManager[F]
class Object
trait Matchable
class Any
Show all

Types

type ConfigResult[+A] = Either[Seq[ConfigError], A]

A type alias for the result of a configuration decoding operation. It represents either a successful decoding with a value of type A or a sequence of configuration errors.

A type alias for the result of a configuration decoding operation. It represents either a successful decoding with a value of type A or a sequence of configuration errors.

Attributes

Extensions

Extensions

extension (simulationConfig: SimulationConfig[ValidEnvironment])
infix def run: IO[Option[SimulationState]]

Runs the simulation in headless mode if a duration is specified.

Runs the simulation in headless mode if a duration is specified.

Attributes

Returns

an IO effect that yields an Option containing the final SimulationState if a duration is specified or None if the simulation runs indefinitely.

Generated with