location-service 5.7.0 API
API
Generated with
location-service 5.7.0 API/io.github.positionpal.location/io.github.positionpal.location.commons

io.github.positionpal.location.commons

package io.github.positionpal.location.commons

Members list

Type members

Classlikes

class ConfigProvider[F[_], C](fileName: String, namespace: String)(using evidence$1: Sync[F], cr: ConfigReader[C], ct: ClassTag[C]) extends ConfigurationProvider[F, C]

A provider of configuration C taken from a .conf file.

A provider of configuration C taken from a .conf file.

Attributes

Note

the ConfigReader must be provided using scala 2 implicits, like this:

 case class MyConfig(somefield: Int, anotherfield: String)
 implicit val reader: ConfigReader[MyConfig] =
   ConfigReader.forProduct2("somefield", "anotherfield")(MyConfig.apply)
Supertypes
trait ConfigurationProvider[F, C]
class Object
trait Matchable
class Any
enum ConfigurationError(val message: String)

A sealed trait representing the possible configuration errors.

A sealed trait representing the possible configuration errors.

Value parameters

message

the error message.

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class NotSet
class Invalid
object ConfigurationError

A set of extension methods to validate configuration parameters.

A set of extension methods to validate configuration parameters.

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait ConfigurationProvider[F[_], C]

A generic provider of configuration C.

A generic provider of configuration C.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ConfigProvider[F, C]
trait ConnectionFactory[F[_], C]

A generic factory of connections.

A generic factory of connections.

Type parameters

C

the connection type

F

the effect type in which the connection is encapsulated

Attributes

Supertypes
class Object
trait Matchable
class Any
class EnvVariablesProvider[F[_]] extends ConfigurationProvider[F, Map[String, String]]

A provider of environment variables.

A provider of environment variables.

Attributes

Supertypes
trait ConfigurationProvider[F, Map[String, String]]
class Object
trait Matchable
class Any
object ScopeFunctions

A set of scope functions (inspired by Kotlin) to improve the readability of the code.

A set of scope functions (inspired by Kotlin) to improve the readability of the code.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

Types

type CanAsk[E] = [M[_]] =>> Ask[M, E]

A type alias for a type constructor M expressing the capability to ask for a value of type E.

A type alias for a type constructor M expressing the capability to ask for a value of type E.

Attributes

type CanRaise[E] = [M[_]] =>> Raise[M, E]

A type alias for a type constructor M expressing the capability to raise an error of type E.

A type alias for a type constructor M expressing the capability to raise an error of type E.

Attributes

type HasState[S] = [M[_]] =>> Stateful[M, S]

A type alias for a type constructor M expressing the capability to have a state of type S.

A type alias for a type constructor M expressing the capability to have a state of type S.

Attributes

Generated with