IFS::FileNameBuffer Struct Reference

a quick'n'dirty name buffer with maximum path allocation More...

#include <NameBuffer.h>

Inheritance diagram for IFS::FileNameBuffer:
[legend]
Collaboration diagram for IFS::FileNameBuffer:
[legend]

Public Member Functions

 FileNameBuffer ()
 
- Public Member Functions inherited from IFS::NameBuffer
 NameBuffer ()
 
 NameBuffer (char *buffer, uint16_t size, uint16_t length=0)
 
 NameBuffer (String &s)
 Make a NameBuffer point to contents of a String. More...
 
 operator const char * () const
 
char * begin ()
 
const char * c_str () const
 
 operator String () const
 
bool operator== (const char *other)
 
int copy (const char *src, uint16_t srclen)
 copies text from a source buffer into a name buffer More...
 
int copy (const char *src)
 
int copy (const NameBuffer &name)
 
int addSep ()
 When building file paths this method simplified appending separators. More...
 
char * endptr ()
 get a pointer to the next write position More...
 
uint16_t space ()
 get the number of free characters available More...
 
void terminate ()
 ensure the buffer has a nul terminator, even if it means overwriting content More...
 
bool overflow () const
 determine if name buffer overflowed More...
 
bool endsWith (const char *suffix) const
 

Additional Inherited Members

- Public Attributes inherited from IFS::NameBuffer
char * buffer {nullptr}
 Buffer to store name. More...
 
uint16_t size {0}
 IN: Size of buffer. More...
 
uint16_t length {0}
 OUT: length of name. More...
 

Detailed Description

a quick'n'dirty name buffer with maximum path allocation

Constructor & Destructor Documentation

◆ FileNameBuffer()

IFS::FileNameBuffer::FileNameBuffer ( )
inline

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