Refactoring of FS::info (#779)

cores/esp8266/FS.cpp

@@ -174,11 +174,11 @@ bool FS::format() {
     return _impl->format();
 }
 
-bool FS::info(uint32_t *total, uint32_t *used){
+bool FS::info(FSInfo& info){
     if (!_impl) {
         return false;
     }
-    return _impl->info(total,used);
+    return _impl->info(info);
 }
 
 File FS::open(const String& path, const char* mode) {

cores/esp8266/FS.h

@@ -85,6 +85,15 @@ protected:
     DirImplPtr _impl;
 };
 
+struct FSInfo {
+    size_t totalBytes;
+    size_t usedBytes;
+    size_t blockSize;
+    size_t pageSize;
+    size_t maxOpenFiles;
+    size_t maxPathLength;
+};
+
 class FS
 {
 public:
@@ -93,7 +102,7 @@ public:
     bool begin();
 
     bool format();
-    bool info(uint32_t *total, uint32_t *used);
+    bool info(FSInfo& info);
 
     File open(const char* path, const char* mode);
     File open(const String& path, const char* mode);
@@ -123,6 +132,7 @@ using fs::SeekMode;
 using fs::SeekSet;
 using fs::SeekCur;
 using fs::SeekEnd;
+using fs::FSInfo;
 
 extern FS SPIFFS;
 

cores/esp8266/FSImpl.h

@@ -64,7 +64,7 @@ class FSImpl {
 public:
     virtual bool begin() = 0;
     virtual bool format() = 0;
-    virtual bool info(uint32_t *total, uint32_t *used) = 0;
+    virtual bool info(FSInfo& info) = 0;
     virtual FileImplPtr open(const char* path, OpenMode openMode, AccessMode accessMode) = 0;
     virtual bool exists(const char* path) = 0;
     virtual DirImplPtr openDir(const char* path) = 0;

cores/esp8266/spiffs_api.cpp

@@ -71,11 +71,15 @@ public:
         }
         return true;
     }
-
+    bool info(FSInfo& info) override {
-    bool info(uint32_t *total, uint32_t *used) override{
+        info.maxOpenFiles = _maxOpenFds;
-    auto rc = SPIFFS_info(&_fs, total, used);
+        info.blockSize = _blockSize;
+        info.pageSize = _pageSize;
+        info.maxOpenFiles = _maxOpenFds;
+        info.maxPathLength = SPIFFS_OBJ_NAME_LEN;
+        auto rc = SPIFFS_info(&_fs, &info.totalBytes, &info.usedBytes);
         if (rc != SPIFFS_OK) {
-            DEBUGV("SPIFFS_format: rc=%d, err=%d\r\n", rc, _fs.err_code);
+            DEBUGV("SPIFFS_info: rc=%d, err=%d\r\n", rc, _fs.err_code);
             return false;
         }
         return true;

doc/reference.md

@@ -266,6 +266,32 @@ SPIFFS.rename(pathFrom, pathTo)
 Renames file from `pathFrom` to `pathTo`. Paths must be absolute. Returns *true*
 if file was renamed successfully.
 
+#### info
+
+```c++
+FSInfo fs_info;
+SPIFFS.info(fs_info);
+```
+
+Fills [FSInfo structure](#filesystem-information-structure) with information about
+the file system. Returns `true` is successful, `false` otherwise.
+
+### Filesystem information structure
+
+```c++
+struct FSInfo {
+    size_t totalBytes;
+    size_t usedBytes;
+    size_t blockSize;
+    size_t pageSize;
+    size_t maxOpenFiles;
+    size_t maxPathLength;
+};
+```
+
+This is the structure which may be filled using FS::info method. Field names
+are self-explanatory.
+
 ### Directory object (Dir)
 
 The purpose of *Dir* object is to iterate over files inside a directory.

tests/FSWrapper/FSWrapper.ino

@@ -111,6 +111,21 @@ void setup() {
     }
   }
 
+  {
+    FSInfo info;
+    if (!SPIFFS.info(info)) {
+      fail("info failed");
+    }
+    Serial.printf("Total: %u\nUsed: %u\nBlock: %u\nPage: %u\nMax open files: %u\nMax path len: %u\n",
+                  info.totalBytes,
+                  info.usedBytes,
+                  info.blockSize,
+                  info.pageSize,
+                  info.maxOpenFiles,
+                  info.maxPathLength
+                 );
+  }
+
   {
     if (!SPIFFS.format()) {
       fail("format failed");