From 2286bee2e433f511da84759aafd383eb0e453eb5 Mon Sep 17 00:00:00 2001 From: IgorTimofeev Date: Wed, 9 Jan 2019 14:38:21 +0300 Subject: [PATCH] Updated Filesystem API (markdown) --- Filesystem-API.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/Filesystem-API.md b/Filesystem-API.md index ac57c16..e85fdd6 100644 --- a/Filesystem-API.md +++ b/Filesystem-API.md @@ -1,15 +1,48 @@ - - This library allows developer to interact with filesystem components, to mount them on virtual directories, to perform buffered I/O operations and to process string paths for extraction of their parts. | Contents | | - | | [Easy methods](#easy-methods) | +| [   filesystem.read](#filesystemreadstring-path-string-or-nil-data-boolean-reason) | +| [   filesystem.write](#filesystemwritestring-path--boolean-success-boolean-reason) | +| [   filesystem.append](#filesystemappendstring-path--boolean-success-boolean-reason) | +| [   filesystem.readLines](#filesystemreadlinesstring-path-table-or-nil-data-boolean-reason) | +| [   filesystem.readTable](#filesystemreadtablestring-path-table-or-nil-data-boolean-reason) | +| [   filesystem.writeTable](#filesystemwritetablestring-path-table-t--boolean-success-boolean-reason) | | [Working with paths](#working-with-paths) | +| [   filesystem.list](#filesystemliststring-path-table-or-nil-list-string-reason) | +| [   filesystem.size](#filesystemsizestring-path-int-or-nil-size-string-reason) | +| [   filesystem.lastModified](#filesystemlastmodifiedstring-path-int-or-nil-timestamp-string-reason) | +| [   filesystem.exists](#filesystemexistsstring-path-boolean-exists) | +| [   filesystem.isDirectory](#filesystemisdirectorystring-path-boolean-isdirectory) | +| [   filesystem.makeDirectory](#filesystemmakedirectorystring-path-boolean-success-string-reason) | +| [   filesystem.remove](#filesystemremovestring-path-boolean-success-string-reason) | +| [   filesystem.rename](#filesystemrenamestring-frompath-string-topath-boolean-success-string-reason) | +| [   filesystem.copy](#filesystemcopystring-frompath-string-topath-boolean-success-string-reason) | +| [   filesystem.name](#filesystemnamestring-path-string-name) | +| [   filesystem.path](#filesystempathstring-path-string-parentpath) | +| [   filesystem.extension](#filesystemextensionstring-path-string-extension) | +| [   filesystem.hideExtension](#filesystemhideextensionstring-path-string-path) | +| [   filesystem.isHidden](#filesystemishiddenstring-path-boolean-ishidden) | +| [   filesystem.removeSlashes](#filesystemremoveslashesstring-path-string-path) | | [Opening file handles](#opening-file-handles) | +| [   filesystem.open](#filesystemopenstring-path-string-mode-table-handle) | +| [   handle:close](#handleclose) | +| [   handle:seek](#handleseekstring-whence-int-offset-int-or-nil-position-string-reason) | | [Reading from handles](#reading-from-handles) | +| [   handle:readString](#handlereadstringint-count-string-or-nil-value) | +| [   handle:readBytes](#handlereadbytesint-count-boolean-littleendian-int-or-nil-value) | +| [   handle:readUnicodeChar](#handlereadunicodechar-string-or-nil-value) | +| [   handle:readLine](#handlereadline-string-or-nil-line) | +| [   handle:readAll](#handlereadall-string-or-nil-data-string-reason) | | [Writing to handles](#writing-to-handles) | +| [   handle:write](#handlewrite-boolean-success-string-reason) | +| [   handle:writeBytes](#handlewritebytes-boolean-success-string-reason) | | [Mounted filesystems](#mounted-filesystems) | +| [   filesystem.mounts](#filesystemmounts-function-iterator---proxy-path) | +| [   filesystem.mount](#filesystemmounttable-proxy-string-path) | +| [   filesystem.unmount](#filesystemunmounttable-proxy-or-string-address) | +| [   filesystem.get](#filesystemgetstring-path-table-proxy-string-proxypath) | # Easy methods