Developer World
Spresense Arduino Library v2.1.0-a3a0200
FlashClass Class Reference

The Flash class provides functions for accessing the flash and manipulating its files and directories. More...

#include <Flash.h>

Inheritance diagram for FlashClass:
Collaboration diagram for FlashClass:

Public Member Functions

boolean begin ()
 Initialize the Flash library. More...
 
int format ()
 Format the Flash device. More...
 
- Public Member Functions inherited from StorageClass
 StorageClass (const char *str)
 
File open (const char *filename, uint8_t mode=FILE_READ)
 Opens a file on the Flash. More...
 
File open (const String &filename, uint8_t mode=FILE_READ)
 Opens a file on the Flash. More...
 
boolean exists (const char *filepath)
 Tests whether a file or directory exists on the Flash. More...
 
boolean exists (const String &filepath)
 Tests whether a file or directory exists on the Flash. More...
 
boolean mkdir (const char *filepath)
 Create a directory on the Flash. More...
 
boolean mkdir (const String &filepath)
 Create a directory on the Flash. More...
 
boolean remove (const char *filepath)
 Remove a file from the Flash. More...
 
boolean remove (const String &filepath)
 Remove a file from the Flash. More...
 
boolean rmdir (const char *filepath)
 Remove a directory from the Flash. More...
 
boolean rmdir (const String &filepath)
 Remove a directory from the Flash. More...
 

Additional Inherited Members

- Protected Attributes inherited from StorageClass
char mountdir [16]
 

Detailed Description

The Flash class provides functions for accessing the flash and manipulating its files and directories.

Member Function Documentation

◆ begin()

boolean FlashClass::begin ( void  )
inline

Initialize the Flash library.

This is a dummy function provided to match other storages as SDHCI and eMMC.

Returns
true

◆ format()

int FlashClass::format ( )

Format the Flash device.

This will format the Flash device to SmartFS file system.

Returns
0 if the Flash format is successful, error code if not

The documentation for this class was generated from the following file: