Packages

o

firrtl

FileUtils

object FileUtils

Source
FileUtils.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileUtils
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def deleteDirectoryHierarchy(directoryPathName: String): Boolean

    recursively delete all directories in a relative path DO NOT DELETE absolute paths

    recursively delete all directories in a relative path DO NOT DELETE absolute paths

    directoryPathName

    a directory hierarchy to delete

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def getLines(file: Path): Seq[String]

    Read a text file and return it as a Seq of strings Closes the file after read to avoid dangling file handles

    Read a text file and return it as a Seq of strings Closes the file after read to avoid dangling file handles

    file

    an os.Path to be read

  11. def getLines(fileName: String): Seq[String]

    Read a text file and return it as a Seq of strings Closes the file after read to avoid dangling file handles

    Read a text file and return it as a Seq of strings Closes the file after read to avoid dangling file handles

    fileName

    The file to read

  12. def getLinesResource(resourceName: String): Seq[String]

    Read text file and return it as a Seq of strings Closes the file after read to avoid dangling file handles

    Read text file and return it as a Seq of strings Closes the file after read to avoid dangling file handles

    resourceName

    a java File to be read

    Note

    resourceName typically begins with a slash.

  13. def getPath(pathName: String): Path

    Get os.Path from String

    Get os.Path from String

    pathName

    an absolute or relative path string

  14. def getText(file: Path): String

    Read a text file and return it as a single string Closes the file after read to avoid dangling file handles

    Read a text file and return it as a single string Closes the file after read to avoid dangling file handles

    file

    an os.Path to be read

  15. def getText(fileName: String): String

    Read a text file and return it as a single string Closes the file after read to avoid dangling file handles

    Read a text file and return it as a single string Closes the file after read to avoid dangling file handles

    fileName

    The file to read

  16. def getTextResource(resourceName: String): String

    Read text file and return it as a single string Closes the file after read to avoid dangling file handles

    Read text file and return it as a single string Closes the file after read to avoid dangling file handles

    resourceName

    a java File to be read

    Note

    resourceName typically begins with a slash.

  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def isCommandAvailable(cmd: String): Boolean

    Indicate if an external command (executable) is available (from the current PATH).

    Indicate if an external command (executable) is available (from the current PATH).

    cmd

    the command/executable (without any arguments).

    returns

    true if cmd returns a 0 exit status.

  19. def isCommandAvailable(cmd: Seq[String]): Boolean

    Indicate if an external command (executable) is available (from the current PATH).

    Indicate if an external command (executable) is available (from the current PATH).

    cmd

    the command/executable plus any arguments to the command as a Seq().

    returns

    true if cmd <args> returns a 0 exit status.

  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. lazy val isVCSAvailable: Boolean

    Flag indicating if vcs is available (for Verilog compilation and testing).

    Flag indicating if vcs is available (for Verilog compilation and testing). We used to use a bash command (which ...) to determine this, but this is problematic on Windows (issue #807). Instead we try to run the executable itself (with innocuous arguments) and interpret any errors/exceptions as an indication that the executable is unavailable.

  22. def makeDirectory(directoryName: String): Boolean

    Create a directory if it doesn't exist

    Create a directory if it doesn't exist

    directoryName

    a directory string with one or more levels

    returns

    true if the directory exists or if it was successfully created

  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def deleteDirectoryHierarchy(file: File, atTop: Boolean = true): Boolean

    recursively delete all directories in a relative path DO NOT DELETE absolute paths

    recursively delete all directories in a relative path DO NOT DELETE absolute paths

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use os-lib instead, this function will be removed in FIRRTL 1.6

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  3. def getLines(file: File): Seq[String]

    Read a text file and return it as a Seq of strings Closes the file after read to avoid dangling file handles

    Read a text file and return it as a Seq of strings Closes the file after read to avoid dangling file handles

    file

    a java File to be read

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use os-lib instead, this function will be removed in FIRRTL 1.6

  4. def getText(file: File): String

    Read a text file and return it as a single string Closes the file after read to avoid dangling file handles

    Read a text file and return it as a single string Closes the file after read to avoid dangling file handles

    file

    a java File to be read

    Annotations
    @deprecated
    Deprecated

    (Since version FIRRTL 1.5) Use os-lib instead, this function will be removed in FIRRTL 1.6

Inherited from AnyRef

Inherited from Any

Ungrouped