FatFsFileReader Class Reference

Buffered line reader for FatFs FILE* files. More...

#include <FatFsFileReader.h>

Inheritance diagram for FatFsFileReader:

Collaboration diagram for FatFsFileReader:

Public Member Functions
	FatFsFileReader ()
	~FatFsFileReader () override
bool	open (const std::string &path)
	Opens a file for reading.
bool	readLine (char *outLine, size_t maxLen) override
	Reads a single line into the provided buffer.
void	close () override
	Closes the file.
Public Member Functions inherited from StorageFileReader
virtual	~StorageFileReader ()=default

Private Attributes
FF_FILE *	file = nullptr
bool	isOpen = false

Detailed Description

Definition at line 10 of file FatFsFileReader.h.

Constructor & Destructor Documentation

FatFsFileReader()

FatFsFileReader::FatFsFileReader ( )

default

~FatFsFileReader()

FatFsFileReader::~FatFsFileReader ( )

override

Definition at line 7 of file FatFsFileReader.cpp.

                                  {
    close();
}

References close().

Here is the call graph for this function:

Member Function Documentation

close()

void FatFsFileReader::close ( )

overridevirtual

Implements StorageFileReader.

Definition at line 18 of file FatFsFileReader.cpp.

                            {
    if (isOpen && file) {
        ff_fclose(file);
        file = nullptr;
        isOpen = false;
    }
}

References file, and isOpen.

Referenced by ~FatFsFileReader().

Here is the caller graph for this function:

open()

bool FatFsFileReader::open

(

const std::string &

path

)

Parameters

path	Path to the file

Returns

true if opened successfully

Definition at line 11 of file FatFsFileReader.cpp.

                                                {
    file = ff_fopen(path.c_str(), "r");
    isOpen = (file != nullptr);
    return isOpen;
}

References file, and isOpen.

readLine()

bool FatFsFileReader::readLine ( char *  outLine, size_t  maxLen  )

overridevirtual

Carriage returns are stripped. Stops at newline or buffer end.

Parameters

outLine	Destination buffer
maxLen	Size of the buffer

Returns

true if line read, false on EOF or error

Implements StorageFileReader.

Definition at line 27 of file FatFsFileReader.cpp.

                                                           {
    if (!isOpen || !file || maxLen == 0) return false;
 
 
    size_t count = 0;
    int ch;
 
    while (count < maxLen - 1) {
        ch = ff_fgetc(file);
        if (ch == EOF) break;
        if (ch == '\n') break;
        if (ch != '\r') {
            outLine[count++] = static_cast<char>(ch);
        }
    }
 
    if (count == 0 && ch == EOF) return false;
 
    outLine[count] = '\0';
    return true;
}

References file, and isOpen.

Member Data Documentation

file

FF_FILE* FatFsFileReader::file = nullptr

private

Definition at line 37 of file FatFsFileReader.h.

Referenced by close(), open(), and readLine().

isOpen

bool FatFsFileReader::isOpen = false

private

Definition at line 38 of file FatFsFileReader.h.

Referenced by close(), open(), and readLine().

---

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

• FatFsFileReader.h
• FatFsFileReader.cpp