LittleFsFileReader Class Reference

Buffered line reader for LittleFS lfs_file_t files. More...

#include <LittleFsFileReader.h>

Inheritance diagram for LittleFsFileReader:

Collaboration diagram for LittleFsFileReader:

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

Private Attributes
lfs_t *	lfs = nullptr
lfs_file_t	file {}
bool	isOpen = false

Detailed Description

Definition at line 10 of file LittleFsFileReader.h.

Constructor & Destructor Documentation

LittleFsFileReader()

LittleFsFileReader::LittleFsFileReader ( lfs_t *  lfs )

explicit

Definition at line 4 of file LittleFsFileReader.cpp.

    : lfs(lfs) {}

~LittleFsFileReader()

LittleFsFileReader::~LittleFsFileReader ( )

override

Definition at line 19 of file LittleFsFileReader.cpp.

{
    close();
}

References close().

Here is the call graph for this function:

Member Function Documentation

close()

void LittleFsFileReader::close ( )

overridevirtual

Implements StorageFileReader.

Definition at line 55 of file LittleFsFileReader.cpp.

{
    if (isOpen) {
        lfs_file_close(lfs, &file);
        isOpen = false;
    }
}

References file, isOpen, and lfs.

Referenced by ~LittleFsFileReader().

Here is the caller graph for this function:

open()

bool LittleFsFileReader::open

(

const std::string &

path

)

Parameters

path	Path to the file

Returns

true if opened successfully

Definition at line 7 of file LittleFsFileReader.cpp.

{
    if (!lfs)
        return false;
    isOpen = (lfs_file_open(lfs, &file, path.c_str(), LFS_O_RDONLY) == 0);
    if (!isOpen)
    {
        return false;
    }
    return isOpen;
}

References file, isOpen, and lfs.

readLine()

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

virtual

Reads characters until newline (\n) or buffer is full. Carriage returns (\r) are stripped. Returns false on EOF or error.

Parameters

outLine	Buffer to store the line
maxLen	Size of the buffer

Returns

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

Implements StorageFileReader.

Definition at line 24 of file LittleFsFileReader.cpp.

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

References file, isOpen, and lfs.

Member Data Documentation

file

lfs_file_t LittleFsFileReader::file {}

private

Definition at line 43 of file LittleFsFileReader.h.

{};

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

isOpen

bool LittleFsFileReader::isOpen = false

private

Definition at line 44 of file LittleFsFileReader.h.

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

lfs

lfs_t* LittleFsFileReader::lfs = nullptr

private

Definition at line 42 of file LittleFsFileReader.h.

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

---

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

• LittleFsFileReader.h
• LittleFsFileReader.cpp