object FileUtils
- Source
- FileUtils.scala
- Alphabetic
- By Inheritance
- FileUtils
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
-
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
-
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.
-
def
getPath(pathName: String): Path
Get os.Path from String
Get os.Path from String
- pathName
an absolute or relative path string
-
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
-
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
-
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.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
returns a 0 exit status.cmd
-
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
returns a 0 exit status.cmd <args>
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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. -
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
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
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated
-
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
-
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
This is the documentation for Firrtl.