locator

File system utility.


Keywords
sys, utility
License
MIT
Install
haxelib install locator 0.4.0

Documentation

locator

File system utility for Haxe.

Requires Haxe 4. Only for sys targets.

(Tested with: Haxe 4.1.1, eval/hl. Some methods are not available on java).

Types

Types based on String

  • PathString: Path of file/directory. Underlying type of FilePath and DirectoryPath.
  • FilePath: File path. The actual file does not necessarily have to exist.
  • FileRef: Represents a file that actually exists.
  • DirectoryPath: Directory path. The actual directory does not necessarily have to exist.
  • DirectoryRef: Represents a directory that actually exists.

The path is automatically converted to absolute when creating any value of the types above.

Other types

  • FileList: Array of FileRefs.
  • DirectoryList: Array of DirectoryRefs.
  • FileOrDirectoryPath: Enum, either FilePath or DirectoryPath.
  • FileOrDirectoryRef: Enum, either FileRef or DirectoryRef.
  • FileOrDirectoryList: Array of FileOrDirectoryRef.

Compilation flags

flag description
locator_validation_disable Skips validation of file/directory paths.

Dependencies

See also: FAL Haxe libraries