FileAttributes.h File Reference
#include "Types.h"
Include dependency graph for FileAttributes.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Namespaces | |
| IFS | |
Macros | |
| #define | IFS_FILEATTR_MAP(XX) |
| file attributes More... | |
| #define | XX(_tag, _char, _comment) _tag, |
Typedefs | |
| using | IFS::FileAttributes = BitSet< uint8_t, FileAttribute, size_t(FileAttribute::MAX)> |
| File attributes are stored as a bitmask. More... | |
Enumerations | |
| enum | IFS::FileAttribute { IFS::FileAttribute::XX, IFS::FileAttribute::MAX } |
Functions | |
| String | IFS::getFileAttributeString (FileAttributes attr) |
| Get the string representation for the given set of file attributes suitable for inclusion in a file listing. More... | |
| String | toString (IFS::FileAttribute attr) |
| Get descriptive String for a given file attribute. More... | |
Macro Definition Documentation
◆ IFS_FILEATTR_MAP
| #define IFS_FILEATTR_MAP | ( | XX | ) |
Value:
XX(Compressed, C, "File content is compressed") \
XX(Archive, A, "File modified flag") \
XX(ReadOnly, R, "File may not be modified or deleted") \
XX(Directory, D, "Object is a directory entry") \
XX(MountPoint, M, "Directs to another object store") \
XX(Encrypted, E, "File is encrypted")
file attributes
Archive: Unlike the dirty flag, this may be written to disk. It is typically used by applications to indicate that a file has been backed up, but may have other uses. Not touched by the filesystem.
Dirty: This is an internal attribute and indicates file content or metadata needs to be flushed to disk. Applications may find it useful to determine if a file has been modified whilst open. Clearing this flag before closing a file will prevent any metadata changes being flushed to disk.
◆ XX
| #define XX | ( | _tag, | |
| _char, | |||
| _comment | |||
| ) | _tag, |
Function Documentation
◆ toString()
| String toString | ( | IFS::FileAttribute | attr | ) |
Get descriptive String for a given file attribute.
