Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/EngineerSmith/nativefs

nativeFS for love2d (clone rehost as it was deleted)
https://github.com/EngineerSmith/nativefs

Last synced: 3 months ago
JSON representation

nativeFS for love2d (clone rehost as it was deleted)

Lists

README 

        
This is a re-host as previously it was taken down by the original developer. Pull requests for fixes are welcome!



# Native filesystem for LÖVE



nativefs replicates a subset of the [love.filesystem](https://love2d.org/wiki/love.filesystem) API, but without LÖVE's path restrictions. 



## Available functions



### nativefs



Links in this list point to their `love.filesystem` counterparts. All functions are designed to behave the same way as `love.filesystem`, but without the path restrictions that LÖVE imposes; i.e., they allow full access to the filesystem.



* [nativefs.newFile](https://love2d.org/wiki/love.filesystem.newFile)

* [nativefs.newFileData](https://love2d.org/wiki/love.filesystem.newFileData)

* [nativefs.mount](https://love2d.org/wiki/love.filesystem.mount)

* [nativefs.unmount](https://love2d.org/wiki/love.filesystem.unmount)

* [nativefs.read](https://love2d.org/wiki/love.filesystem.read)

* [nativefs.write](https://love2d.org/wiki/love.filesystem.write)

* [nativefs.append](https://love2d.org/wiki/love.filesystem.append)

* [nativefs.lines](https://love2d.org/wiki/love.filesystem.lines)

* [nativefs.load](https://love2d.org/wiki/love.filesystem.load)

* [nativefs.getWorkingDirectory](https://love2d.org/wiki/love.filesystem.getWorkingDirectory)

* [nativefs.getDirectoryItems](https://love2d.org/wiki/love.filesystem.getDirectoryItems)

* [nativefs.getInfo](https://love2d.org/wiki/love.filesystem.getInfo)

* [nativefs.createDirectory](https://love2d.org/wiki/love.filesystem.createDirectory)

* [nativefs.remove](https://love2d.org/wiki/love.filesystem.remove)

* nativefs.getDirectoryItemsInfo

* nativefs.getDriveList

* nativefs.setWorkingDirectory



#### Additional `nativefs` functions



Functions that are not available in `love.filesystem`:



* `nativefs.getDirectoryItemsInfo(path)`  

Returns a list of items in a directory that contains not only the names, but also the information returned by `getInfo` for each item. The return value is a list of files and directories, in which each entry is a table as returned by [getInfo](https://love2d.org/wiki/love.filesystem.getInfo), with an additional `name` field for each entry. Using this function is faster than calling `getInfo` separately for each item.



* `nativefs.getDriveList()`  

Returns a table with all populated drive letters on Windows (`{ 'C:/', 'D:/', ...}`). On systems that don't use drive letters, a table with the single entry `/` is returned.



* `nativefs.setWorkingDirectory(directory)`  

Changes the working directory.



### File



`nativefs.newFile` returns a `File` object that provides these functions:



* [File:open](https://love2d.org/wiki/\(File\):open)

* [File:close](https://love2d.org/wiki/\(File\):close)

* [File:read](https://love2d.org/wiki/\(File\):read)

* [File:write](https://love2d.org/wiki/\(File\):write)

* [File:lines](https://love2d.org/wiki/\(File\):lines)

* [File:isOpen](https://love2d.org/wiki/\(File\):isOpen)

* [File:isEOF](https://love2d.org/wiki/\(File\):isEOF)

* [File:getFilename](https://love2d.org/wiki/\(File\):getFilename)

* [File:getMode](https://love2d.org/wiki/\(File\):getMode)

* [File:getBuffer](https://love2d.org/wiki/\(File\):getBuffer)

* [File:setBuffer](https://love2d.org/wiki/\(File\):setBuffer)

* [File:getSize](https://love2d.org/wiki/\(File\):getSize)

* [File:seek](https://love2d.org/wiki/\(File\):seek)

* [File:tell](https://love2d.org/wiki/\(File\):tell)

* [File:flush](https://love2d.org/wiki/\(File\):flush)

* [File:type](https://love2d.org/wiki/Object:type)

* [File:typeOf](https://love2d.org/wiki/Object:typeOf)

* [File:release](https://love2d.org/wiki/Object:release)



Function names in this list are links to their LÖVE `File` counterparts. `File` is designed to work the same way as LÖVE's `File` objects.



## Example



```lua

local nativefs = require("nativefs")



-- Prints all information on files in C:\Windows

local files = nativefs.getDirectoryItemsInfo("C:/Windows")

for i = 1, #files do

  if files[i].type == "file" then

    local info = nativefs.getInfo("C:/Windows/" .. files[i].name)

    print(i .. ": " .. files[i] .. " : Type:" .. info.type .. ", Size:" .. tostring(info.size) .. ", last modified:" .. tostring(info.modtime))

  end

end

```

## License

Copyright 2020 [email protected]



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.