YamlConfigSource

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 fromYamlFile(file: File): config.ConfigSource

   

   Retrieve a ConfigSource from yaml path.

   Retrieve a ConfigSource from yaml path.

   A complete example usage:

   case class MyConfig(port: Int, url: String)
   
   val result: Either[ReadError[String], MyConfig] =
     YamlConfigSource.fromYamlFile(new File("/path/to/file.yaml"))
       .flatMap(source => read(descriptor[MyConfig] from source)))

10. def fromYamlPath(path: Path): config.ConfigSource

    

    Retrieve a ConfigSource from yaml path.

    Retrieve a ConfigSource from yaml path.

    A complete example usage:

    case class MyConfig(port: Int, url: String)
    
    val result: Either[ReadError[String], MyConfig] =
      YamlConfigSource.fromYamlPath(Path.of("/path/to/file.yaml"))
        .flatMap(source => read(descriptor[MyConfig] from source)))

11. def fromYamlReader(reader: Reader, sourceName: String = "yaml"): config.ConfigSource

    

    Retrieve a ConfigSource from yaml reader.

    Retrieve a ConfigSource from yaml reader.

    A complete example usage:

    import zio.*
    import scala.io.Source
    import java.io.InputStreamReader
    import zio.config.yaml.YamlConfigSource
    
    case class MyConfig(port: Int, url: String)
    
    def acquire(yamlResourcePath: String) = ZIO.effect(Source.fromResource(yamlResourcePath).reader)
    def release(reader: InputStreamReader) = ZIO.effectTotal(reader.close())
    
    val myConfig: InputStreamReader => IO[ReadError[String], MyConfig] = reader =>
      IO.fromEither(
         for {
           source <- YamlConfigSource.fromYamlReader(reader)
           myConfig <- read(descriptor[MyConfig] from source)
         } yield myConfig
      )
    
    val result: Task[MyConfig] = ZManaged.make(acquire("relative/path/to/your/application/resource.yml"))(release).use(myConfig)

12. def fromYamlString(yamlString: String, sourceName: String = "yaml"): config.ConfigSource

    

    Retrieve a ConfigSource from yaml path.

    Retrieve a ConfigSource from yaml path.

    A complete example usage:

    val yamlString = ???
    
    case class MyConfig(port: Int, url: String)
    
    val result: Either[ReadError[String], MyConfig] =
      YamlConfigSource.fromYamlString(yamlString))
        .flatMap(source => read(descriptor[MyConfig] from source)))

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

    

    Definition Classes

    AnyRef → Any

14. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

15. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    AnyRef

17. final def notify(): Unit

    

    Definition Classes

    AnyRef

18. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    AnyRef

20. def toString(): String

    

    Definition Classes

    AnyRef → Any

21. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )