OpenFlags.h File Reference
#include "Types.h"
Include dependency graph for OpenFlags.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_OPEN_FLAG_MAP(XX)
 File open flag. More...
 
#define XX(_tag, _comment)   _tag,
 

Typedefs

using IFS::OpenFlags = BitSet< uint8_t, OpenFlag, size_t(OpenFlag::MAX)>
 

Enumerations

enum  IFS::OpenFlag { IFS::OpenFlag::XX, IFS::OpenFlag::MAX }
 

Functions

constexpr OpenFlags IFS::operator| (OpenFlag a, OpenFlag b)
 
String toString (IFS::OpenFlag flag)
 Get a descriptive string for a flag. More...
 

Macro Definition Documentation

◆ IFS_OPEN_FLAG_MAP

#define IFS_OPEN_FLAG_MAP (   XX)
Value:
XX(Append, "Append to file") \
XX(Truncate, "Create empty file") \
XX(Create, "Create new file if file doesn't exist") \
XX(Read, "Read access") \
XX(Write, "Write access") \
XX(NoFollow, "Don't follow symbolic links")
#define XX(_tag, _comment)
Definition: OpenFlags.h:43

File open flag.

Note
These are filing-system independent flags based on SPIFFS 0.3.7, however they may change so filing systems should map them. A filing system must fail the call if any flags are not recognised. Flags are defined as bit values.

◆ XX

#define XX (   _tag,
  _comment 
)    _tag,

Function Documentation

◆ toString()

String toString ( IFS::OpenFlag  flag)

Get a descriptive string for a flag.