Packages

object StringFS

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StringFS
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 asString(root: io.AbsolutePath, includePath: (io.RelativePath) => Boolean = _ => true, charset: Charset = StandardCharsets.UTF_8): String

    Gives a string representation of a directory.

    Gives a string representation of a directory.

    Performs the inverse as fromString.

    Example:

    val layout = """
    /Main.scala
    object A { def foo() = print("foo") }
    """
    assert(asString(fromString(layout)) == layout)
    root

    the directory to print as a string

    includePath

    an optional filter function to exclude files

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def fromString(layout: String, root: io.AbsolutePath = AbsolutePath(Files.createTempDirectory("scalameta")), charset: Charset = StandardCharsets.UTF_8): io.AbsolutePath

    Creates a temporary directory with a layout matching the markup in the string.

    Creates a temporary directory with a layout matching the markup in the string.

    Example syntax of the expected markup in the string:

    fromString("""
    /build.sbt
    lazy val core = project
    /src/main/scala/core/Foo.scala
    package core
    object Foo.scala
    """)

    Use asString for the inverse, go from a temporary directory to a string.

    layout

    the string representing the directory layout. NOTE. Lines starting with forward slash / are always interpreted as the start of a new file entry.

    root

    the temporary directory to apply the layout markup. If not provided, defaults to a fresh temporary directory.

  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped