FsFile Class Reference

FsBaseFile file with Arduino Stream. More...

#include <FsFile.h>

Inherits StreamFile< FsBaseFile, uint64_t >.

Public Member Functions
FsFile	openNextFile (oflag_t oflag=O_RDONLY)
Public Member Functions inherited from StreamFile< FsBaseFile, uint64_t >
	StreamFile ()
int	available ()
void	flush ()
bool	isDirectory ()
const char *	name () const
int	peek ()
uint64_t	position ()
int	read ()
void	rewindDirectory ()
bool	seek (uint64_t pos)
uint64_t	size ()
size_t	write (uint8_t b)
Public Member Functions inherited from FsBaseFile
	FsBaseFile ()
	FsBaseFile (const char *path, oflag_t oflag)
	~FsBaseFile ()
	FsBaseFile (const FsBaseFile &from)
FsBaseFile &	operator= (const FsBaseFile &from)
	operator bool () const
int	available () const
uint64_t	available64 () const
void	clearWriteError ()
bool	close ()
bool	contiguousRange (uint32_t *bgnSector, uint32_t *endSector)
uint64_t	curPosition () const
uint32_t	dirIndex () const
bool	exists (const char *path)
void	fgetpos (fspos_t *pos) const
int	fgets (char *str, int num, char *delim=nullptr)
uint64_t	fileSize () const
uint32_t	firstSector () const
void	flush ()
void	fsetpos (const fspos_t *pos)
bool	getAccessDateTime (uint16_t *pdate, uint16_t *ptime)
bool	getCreateDateTime (uint16_t *pdate, uint16_t *ptime)
uint8_t	getError () const
bool	getModifyDateTime (uint16_t *pdate, uint16_t *ptime)
size_t	getName (char *name, size_t len)
bool	getWriteError () const
bool	isBusy ()
bool	isContiguous () const
bool	isDir () const
bool	isDirectory () const
bool	isFile () const
bool	isHidden () const
bool	isOpen () const
bool	isReadable () const
bool	isReadOnly () const
bool	isSubDir () const
bool	isWritable () const
bool	ls (uint8_t flags)
bool	ls ()
bool	ls (print_t *pr)
bool	ls (print_t *pr, uint8_t flags)
bool	mkdir (FsBaseFile *dir, const char *path, bool pFlag=true)
const char *	name () const
bool	open (FsBaseFile *dir, const char *path, oflag_t oflag=O_RDONLY)
bool	open (FsBaseFile *dir, uint32_t index, oflag_t oflag)
bool	open (FsVolume *vol, const char *path, oflag_t oflag)
bool	open (const char *path, oflag_t oflag=O_RDONLY)
bool	openNext (FsBaseFile *dir, oflag_t oflag=O_RDONLY)
bool	openRoot (FsVolume *vol)
uint64_t	position () const
int	peek ()
bool	preAllocate (uint64_t length)
size_t	printAccessDateTime (print_t *pr)
size_t	printCreateDateTime (print_t *pr)
size_t	printField (double value, char term, uint8_t prec=2)
size_t	printField (float value, char term, uint8_t prec=2)
template<typename Type>
size_t	printField (Type value, char term)
size_t	printFileSize (print_t *pr)
size_t	printModifyDateTime (print_t *pr)
size_t	printName (print_t *pr)
int	read ()
int	read (void *buf, size_t count)
bool	remove ()
bool	remove (const char *path)
bool	rename (const char *newPath)
bool	rename (FsBaseFile *dirFile, const char *newPath)
void	rewind ()
void	rewindDirectory ()
bool	rmdir ()
bool	seek (uint64_t pos)
bool	seekCur (int64_t offset)
bool	seekEnd (int64_t offset=0)
bool	seekSet (uint64_t pos)
uint64_t	size () const
bool	sync ()
bool	timestamp (uint8_t flags, uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)
bool	truncate ()
bool	truncate (uint64_t length)
size_t	write (uint8_t b)
size_t	write (const void *buf, size_t count)

Detailed Description

FsBaseFile file with Arduino Stream.

Member Function Documentation

openNextFile()

FsFile FsFile::openNextFile ( oflag_t oflag = O_RDONLY )

inline

Opens the next file or folder in a directory.

Parameters

[in]

oflag

open flags.

Returns

a FatStream object.

---

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

• FsFile.h