Files Library (ssk.files.*)

WARNING - You should consider this an advanced library and use it with caution and clarity of purpose. While I have taken steps to reduce the likelihood of you deleting your hard drive, I won't say it is impossible if you try hard enough.

~ The Roaming Gamer

This library gives you the ability to fully explore, modify, copy, move, and remove folders and files in the current OS file-system. The only limits are the permissions the current OS has granted your application.

This library has been tested on these operating systems:

Android (multiple versions)
iOS (multiple versions)
Windows (7,8,10) - This includes in the simulator and Desktop builds.
OS X (multiple versions) - This includes in the simulator and Desktop builds.

Documents Folder (ssk.files.documents.*)

getRoot() - Returns a string containing the full OS-path to the system.DocumentsDirectory folder.
getPath( path ) - This returns a string catenating path to the full OS-path to the system.DocumentsDirectory folder.

Resource Folder (ssk.files.resource.*)

getRoot() - Returns a string containing the full OS-path to the system.ResourceDirectory folder.
getPath( path ) - This returns a string catenating path to the full OS-path to the system.ResourceDirectory folder.

Temporary Folder (ssk.files.temporary.*)

getRoot() - Returns a string containing the full OS-path to the system.TemporaryDirectory folder.
getPath( path ) - This returns a string catenating path to the full OS-path to the system.TemporaryDirectory folder.

Desktop (OS X and Windows) (ssk.files.desktop.*)

getDesktopRoot() - Returns a string containing the full OS-path to the user's Desktop.
getDesktopPath( path ) - Catenates path to a string containing the full OS-path to the user's Desktop.
getMyDocumentsRoot() - Returns a string containing the full OS-path to the user's Documents Folder.
getMyDocumentsPath( path ) - Catenates path to a string containing the full OS-path to the user's Documents Folder.
getDrivePath( path ) - Returns the OS-specific drive path for any named drive path.
explore( path ) - Opens path folder using the current OSes file explorer utility.

Utilities (ssk.files.util.*)

appendFile( data, path ) - Appends the string in data to the file at path, creating the file if it does not yet exists.
dumpAttributes( path ) - Prints the file system attributes of the file/folder at path to the console.
cpFile( src, dst ) - Copies the a file src to the folder dst.
cpFolder( src, dst ) - Copies the a folder srcto the folder dst.
exists( path ) - Returns true if the file at path exists. Returns false otherwise.
isFile( path ) - Returns true if the file at path is in fact a file and not some other file type. Returns false otherwise.
isFolder( path ) - - Returns true if the file at path is in fact a folder and not some other file type. Returns false otherwise.
loadTable( path, secure ) - Reads a JSON encoded text file at path and returns it as a decoded table. Optionally uses the ssk.security system if secure is specified and `true.
mkFolder( path ) - Makes a folder named path.
- Tip: - This can only make the final folder in the path and will not create entire hieararchies of folders if they do not exist yet.
mvFile( src, dst ) - Moves the file at src to dst, where src and dst are complete paths.
mvFolder( src, dst ) - Moves the folder at src to dst, where src and dst are complete paths.
readFile( path ) - Returns a string containing the contents of the file at path or nil if the file cannot be read.
readFileToTable( path ) - Returns a table containing the contents of the file at path or {} if the file cannot be read.
- Tip: - This table is numerically indexed and each entry represents a line in the file separated by the newline character \n.
repairPath( path, forceForward ) - Returns a string with the slashes leaning in the right direction for the current OS.
- If forceForward is specified and true, the slashes will all be forced to be forward leaning.
rmFile( path ) - Removes the file or folder at path.
rmFolder( path ) - Removes the folder at path.
saveTable( tbl, path, secure ) - Saves table tbl as a JSON encoded text file to path and optionally uses the ssk.security system if secure is specified and `true.
writeFile( data, path ) - Writes the string data to the file at path, replacing the file if it already exists.