class File
package sys.io
API for reading and writing files.
See sys.FileSystem
for the complementary file system API.
Static methods
staticappend(path:String, binary:Bool = true):FileOutput
Similar to sys.io.File.write
, but appends to the file if it exists
instead of overwriting its contents.
staticcopy(srcPath:String, dstPath:String):Void
Copies the contents of the file specified by srcPath
to the file
specified by dstPath
.
If the srcPath
does not exist or cannot be read, or if the dstPath
file cannot be written to, an exception is thrown.
If the file at dstPath
exists, its contents are overwritten.
If srcPath
or dstPath
are null, the result is unspecified.
staticgetBytes(path:String):Bytes
Retrieves the binary content of the file specified by path
.
If the file does not exist or can not be read, an exception is thrown.
sys.FileSystem.exists
can be used to check for existence.
If path
is null, the result is unspecified.
staticgetContent(path:String):String
Retrieves the content of the file specified by path
as a String.
If the file does not exist or can not be read, an exception is thrown.
sys.FileSystem.exists
can be used to check for existence.
If path
is null, the result is unspecified.
staticread(path:String, binary:Bool = true):FileInput
Returns an FileInput
handle to the file specified by path
.
If binary
is true, the file is opened in binary mode. Otherwise it is
opened in non-binary mode.
If the file does not exist or can not be read, an exception is thrown.
Operations on the returned FileInput
handle read on the opened file.
File handles should be closed via FileInput.close
once the operation
is complete.
If path
is null, the result is unspecified.
staticsaveBytes(path:String, bytes:Bytes):Void
Stores bytes
in the file specified by path
in binary mode.
If the file cannot be written to, an exception is thrown.
If path
or bytes
are null, the result is unspecified.
staticsaveContent(path:String, content:String):Void
Stores content
in the file specified by path
.
If the file cannot be written to, an exception is thrown.
If path
or content
are null, the result is unspecified.
staticupdate(path:String, binary:Bool = true):FileOutput
Similar to sys.io.File.append
. While append
can only seek or write
starting from the end of the file's previous contents, update
can
seek to any position, so the file's previous contents can be
selectively overwritten.
staticwrite(path:String, binary:Bool = true):FileOutput
Returns an FileOutput
handle to the file specified by path
.
If binary
is true, the file is opened in binary mode. Otherwise it is
opened in non-binary mode.
If the file cannot be written to, an exception is thrown.
Operations on the returned FileOutput
handle write to the opened file.
If the file existed, its previous content is overwritten.
File handles should be closed via FileOutput.close
once the operation
is complete.
If path
is null, the result is unspecified.