View source

class FileSystem

package sys

@:directlyUsed@:buildXml("<include name=\"${HXCPP}/src/hx/libs/std/Build.xml\"/>")@:coreApi

Available on cpp, php, macro, jvm, hl, neko, lua, python

This class provides information about files and directories.

If null is passed as a file path to any function in this class, the result is unspecified, and may differ from target to target.

See sys.io.File for the complementary file API.

Static methods

@:keepstaticabsolutePath(relPath:String):String

Returns the full path of the file or directory specified by relPath, which is relative to the current working directory. The path doesn't have to exist.

@:keepstaticcreateDirectory(path:String):Void

Creates a directory specified by path.

This method is recursive: The parent directories don't have to exist.

If the directory cannot be created, an exception is thrown.

@:keepstaticdeleteDirectory(path:String):Void

Deletes the directory specified by path. Only empty directories can be deleted.

If path does not denote a valid directory, or if that directory cannot be deleted, an exception is thrown.

@:keepstaticdeleteFile(path:String):Void

Deletes the file specified by path.

If path does not denote a valid file, or if that file cannot be deleted, an exception is thrown.

@:keepstaticexists(path:String):Bool

Returns true if the file or directory specified by path exists.

@:keepstaticfullPath(relPath:String):String

Returns the full path of the file or directory specified by relPath, which is relative to the current working directory. Symlinks will be followed and the path will be normalized.

@:keepstaticisDirectory(path:String):Bool

Returns true if the file or directory specified by path is a directory.

If path is not a valid file system entry or if its destination is not accessible, an exception is thrown.

@:keepstaticreadDirectory(path:String):Array<String>

Returns the names of all files and directories in the directory specified by path. "." and ".." are not included in the output.

If path does not denote a valid directory, an exception is thrown.

@:keepstaticrename(path:String, newPath:String):Void

Renames/moves the file or directory specified by path to newPath.

If path is not a valid file system entry, or if it is not accessible, or if newPath is not accessible, an exception is thrown.

@:has_untyped@:keepstaticstat(path:String):FileStat

Returns FileStat information for the file or directory specified by path.