TypesafeConfig

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

7. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

8. def finalize(): Unit

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

9. def fromDefaultLoader[A](configDescriptor: config.ConfigDescriptor[A])(implicit tag: zio.Tag[A]): Layer[ReadError[String], Has[A]]

   

   Retrieve your config from a given file in resource classpath, that is following HOCON format.

   Retrieve your config from a given file in resource classpath, that is following HOCON format. A simple key value file with the name sufficed by .properties will work.

   A complete example usage:

   import zio.config.magnolia.DeriveConfigDescriptor.descriptor
   
   case class MyConfig(port: Int, url: String)
   
   val result: Layer[ReadError[String], Has[MyConfig]] =
     TypesafeConfig.fromDefaultLoader(descriptor[MyConfig])

10. def fromHoconFile[A](file: File, configDescriptor: config.ConfigDescriptor[A])(implicit tag: zio.Tag[A]): Layer[ReadError[String], Has[A]]

    

    Retrieve your config from a HOCON file

    Retrieve your config from a HOCON file

    A complete example usage:

    import zio.config.magnolia.DeriveConfigDescriptor.descriptor
    
    case class MyConfig(port: Int, url: String)
    
    val result: Layer[ReadError[String], Has[MyConfig]] =
      TypesafeConfig.fromHoconFile(new File("/path/to/xyz.hocon"), descriptor[MyConfig])

11. def fromHoconFileM[R, E >: ReadError[String], A](getFile: ZIO[R, E, File], configDescriptor: config.ConfigDescriptor[A])(implicit tag: zio.Tag[A]): ZLayer[R, E, Has[A]]

    

    Retrieve a config from a Hocon file calculated by an effect

    Retrieve a config from a Hocon file calculated by an effect

    A complete example usage:

    import zio.config.magnolia.DeriveConfigDescriptor.descriptor
    
    case class MyConfig(port: Int, url: String)
    
    val result: Layer[ReadError[String], Has[MyConfig]] =
      TypesafeConfig.fromHoconFileM(ZIO.succeed(new File("/path/to/xyz.hocon")), descriptor[MyConfig])

12. def fromHoconString[A](str: String, configDescriptor: config.ConfigDescriptor[A])(implicit tag: zio.Tag[A]): Layer[ReadError[String], Has[A]]

    

    Retrieve a config from a given Hocon string.

    Retrieve a config from a given Hocon string.

    A complete example usage:

    import zio.config.magnolia.DeriveConfigDescriptor.descriptor
    
    case class MyConfig(port: Int, url: String)
    
    val configString = """port: 10, url: "http://x.y""""
    val result: Layer[ReadError[String], Has[MyConfig]] =
      TypesafeConfig.fromHoconString(configString, descriptor[MyConfig])

13. def fromHoconStringM[R, E >: ReadError[String], A](getStr: ZIO[R, E, String], configDescriptor: config.ConfigDescriptor[A])(implicit tag: zio.Tag[A]): ZLayer[R, E, Has[A]]

    

    Retrieve a config from a HOCON string value produced by an effect

    Retrieve a config from a HOCON string value produced by an effect

    A complete example usage:

    import zio.config.magnolia.DeriveConfigDescriptor.descriptor
    
    case class MyConfig(port: Int, url: String)
    
    val configString = """port: 10, url: "http://x.y""""
    val result: Layer[ReadError[String], Has[MyConfig]] =
      TypesafeConfig.fromHoconStringM(ZIO.succeed(configString), descriptor[MyConfig])

14. def fromTypesafeConfig[A](conf: ⇒ Config, configDescriptor: config.ConfigDescriptor[A])(implicit tag: zio.Tag[A]): Layer[ReadError[String], Has[A]]

    

    Retrieve a config from com.typesafe.config.Config

    Retrieve a config from com.typesafe.config.Config

    A complete example usage:

    import zio.config.magnolia.DeriveConfigDescriptor.descriptor
    
    case class MyConfig(port: Int, url: String)
    
    val result: Layer[ReadError[String], Has[MyConfig]] =
      TypesafeConfig.fromTypesafeConfig(ConfigFactory.load.resolve, descriptor[MyConfig])

15. def fromTypesafeConfigM[R, E >: ReadError[String], A](getConfig: ZIO[R, E, Config], configDescriptor: config.ConfigDescriptor[A])(implicit tag: zio.Tag[A]): ZLayer[R, E, Has[A]]

    

    Retrieve a config from com.typesafe.config.Config returned by an effect

    Retrieve a config from com.typesafe.config.Config returned by an effect

    A complete example usage:

    import zio.config.magnolia.DeriveConfigDescriptor.descriptor
    
    case class MyConfig(port: Int, url: String)
    
    val result: Layer[Throwable, Has[MyConfig]] =
      TypesafeConfig.fromTypesafeConfigM(ZIO.effect(ConfigFactory.load.resolve), descriptor[MyConfig])

16. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

17. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

18. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

19. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

20. final def notify(): Unit

    

    Definition Classes

    AnyRef

21. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

22. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

23. def toString(): String

    

    Definition Classes

    AnyRef → Any

24. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

25. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

26. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )