StorageFileReader Class Reference

Abstract interface for reading a file line-by-line. More...

#include <StorageFileReader.h>

Inheritance diagram for StorageFileReader:

Collaboration diagram for StorageFileReader:

Public Member Functions
virtual	~StorageFileReader ()=default
virtual bool	readLine (char *buffer, size_t maxLen)=0
	Reads a single line into the provided buffer.
virtual void	close ()=0
	Close the file and release resources.

Detailed Description

Definition at line 6 of file StorageFileReader.h.

Constructor & Destructor Documentation

~StorageFileReader()

virtual StorageFileReader::~StorageFileReader ( )

virtualdefault

Member Function Documentation

close()

virtual void StorageFileReader::close ( )

pure virtual

Implemented in FatFsFileReader, and LittleFsFileReader.

readLine()

virtual bool StorageFileReader::readLine ( char *  buffer, size_t  maxLen  )

pure virtual

The newline character is stripped.

Parameters

buffer	A character buffer
maxLen	Maximum number of characters to read (including null terminator)

Returns

true if a line was read, false on EOF or error

Implemented in LittleFsFileReader, and FatFsFileReader.

---

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

• StorageFileReader.h