Directory

The Directory class provides an interface for managing and interacting with directories and files within a file system. It supports operations such as opening and closing directories, retrieving directory and file attributes, and querying metadata like modification time, size, and access time. The class allows access to both files and subdirectories, with methods to retrieve names, attributes, and sizes, as well as to manipulate these entities. It includes utility functions to check if an entity is a file or directory and to handle common directories. Additionally, the Directory class provides static methods for performing file and directory management tasks. This class is essential for applications that need to navigate and manipulate the file system structure.

#include <core/TellusimDirectory.h>

Constructors

Directory()

Methods

Open/close directory.

bool open(const char *name, bool children = false)
bool open(const String &name, bool children = false)
void close()

---

Directory status.

bool isOpened() const
String getName() const

---

Files.

uint32_t getNumFiles() const
String getFileName(uint32_t index) const
Attributes getFileAttributes(uint32_t index) const
uint64_t getFileMTime(uint32_t index) const
uint64_t getFileATime(uint32_t index) const
uint64_t getFileCTime(uint32_t index) const
size_t getFileSize(uint32_t index) const
const Array<String> getFiles() const

---

Directories.

uint32_t getNumDirectories() const
String getDirectoryName(uint32_t index) const
Attributes getDirectoryAttributes(uint32_t index) const
uint64_t getDirectoryCTime(uint32_t index) const
uint32_t getDirectorySize(uint32_t index) const
const Array<String> getDirectories() const

---

File utils.

static bool isFile(const char *name)
static bool isFile(const String &name)
static bool setFileAttributes(const char *name, Attributes attributes)
static Attributes getFileAttributes(const char *name)
static bool setFileMTime(const char *name, uint64_t time)
static uint64_t getFileMTime(const char *name)
static uint64_t getFileATime(const char *name)
static uint64_t getFileCTime(const char *name)
static size_t getFileSize(const char *name)
static size_t getFileSize(const String &name)
static bool removeFile(const char *name)
static bool removeFile(const String &name)
static bool copyFile(const char *name, const char *new_name, bool attributes = false)
static bool copyFile(const String &name, const String &new_name, bool attributes = false)

---

Directory utils.

static bool isDirectory(const char *name)
static bool isDirectory(const String &name)
static bool changeDirectory(const char *name)
static bool changeDirectory(const String &name)
static bool createDirectory(const char *name, bool children = false)
static bool createDirectory(const String &name, bool children = false)
static bool removeDirectory(const char *name, bool children = false)
static bool removeDirectory(const String &name, bool children = false)
static bool copyDirectory(const char *name, const char *new_name, bool attributes = false)
static bool copyDirectory(const String &name, const String &new_name, bool attributes = false)
static bool rename(const char *name, const char *new_name)
static bool rename(const String &name, const String &new_name)

---

Common directories.

static String getCurrentDirectory()
static String getHomeDirectory()
static String getTempDirectory()
static String getConfigDirectory()
static String getDocumentsDirectory()

---

Drive utils.

static const Array<String> getDriveNames()

Enums

Attributes

Attributes.

Name	Value	Description
AttributeNone	0
AttributeRead	(1 << 0)	Read access.
AttributeWrite	(1 << 1)	Write access.
AttributeHidden	(1 << 2)	Hidden flag.
AttributeExecute	(1 << 3)	Execute flag.
AttributeTemporary	(1 << 4)	Temporary flag.
NumAttributes	5