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): Either[ReadError[String], 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): Either[ReadError[String], 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 fromYamlString(yamlString: String, sourceName: String = "yaml"): Either[ReadError[String], 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)))

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

    

    Definition Classes

    AnyRef → Any

13. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

14. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    AnyRef

16. final def notify(): Unit

    

    Definition Classes

    AnyRef

17. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    AnyRef

19. def toString(): String

    

    Definition Classes

    AnyRef → Any

20. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )