Integration class for the FatLib library. More...

#include <FatVolume.h>

Public Member Functions
bool	begin (BlockDevice *dev, bool setCwv=true, uint8_t part=1)

void	chvol ()

bool	chdir ()

bool	chdir (const char *path)

bool	exists (const char *path)

bool	ls (print_t *pr, uint8_t flags=0)

bool	ls (print_t pr, const char path, uint8_t flags)

bool	mkdir (const char *path, bool pFlag=true)

File32	open (const char *path, oflag_t oflag=O_RDONLY)

bool	remove (const char *path)

bool	rename (const char oldPath, const char newPath)

bool	rmdir (const char *path)

bool	truncate (const char *path, uint32_t length)

bool	ls (uint8_t flags=0)

bool	ls (const char *path, uint8_t flags=0)

bool	chdir (const String &path)

bool	exists (const String &path)

bool	mkdir (const String &path, bool pFlag=true)

File32	open (const String &path, oflag_t oflag=O_RDONLY)

bool	remove (const String &path)

bool	rename (const String &oldPath, const String &newPath)

bool	rmdir (const String &path)

bool	truncate (const String &path, uint32_t length)

Public Member Functions inherited from FatPartition
	FatPartition ()

uint8_t	bytesPerClusterShift () const

uint16_t	bytesPerCluster () const

uint16_t	bytesPerSector () const

uint8_t	bytesPerSectorShift () const

uint16_t	sectorMask () const

uint8_t	sectorsPerCluster () const

uint8_t	blocksPerCluster () __attribute__((deprecated))

uint32_t	sectorsPerFat () const

uint8_t *	cacheClear ()

uint32_t	clusterCount () const

uint8_t	sectorsPerClusterShift () const

uint32_t	dataStartSector () const

uint8_t	fatCount () const

uint32_t	fatStartSector () const

uint8_t	fatType () const

int32_t	freeClusterCount ()

bool	init (BlockDevice *dev, uint8_t part=1)

uint16_t	rootDirEntryCount () const

uint32_t	rootDirStart () const

uint32_t	volumeSectorCount () const

int8_t	dbgFat (uint32_t n, uint32_t *v)

bool	isBusy ()

void	dmpDirSector (print_t *pr, uint32_t sector)

void	dmpFat (print_t *pr, uint32_t start, uint32_t count)

void	dmpRootDir (print_t *pr)

void	dmpSector (print_t *pr, uint32_t sector, uint8_t bits=8)

Private Member Functions
FatFile *	vwd ()

Static Private Member Functions
static FatVolume *	cwv ()

Private Attributes
friend	FatFile

FatFile	m_vwd

Static Private Attributes
static FatVolume *	m_cwv = nullptr

Detailed Description

Integration class for the FatLib library.

Member Function Documentation

◆ begin()

bool FatVolume::begin	(	BlockDevice *	dev,
		bool	setCwv = `true`,
		uint8_t	part = `1`
	)

inline

Initialize an FatVolume object.

Parameters

[in]	dev	Device block driver.
[in]	setCwv	Set current working volume if true.
[in]	part	partition to initialize.

Returns: true for success or false for failure.

◆ chdir() [1/3]

bool FatVolume::chdir ( )

inline

Set volume working directory to root.

Returns: true for success or false for failure.

◆ chdir() [2/3]

bool FatVolume::chdir ( const char * path )

Set volume working directory.

Parameters

[in] path Path for volume working directory.

Returns: true for success or false for failure.

◆ chdir() [3/3]

bool FatVolume::chdir ( const String & path )

inline

Set volume working directory.

Parameters

[in] path Path for volume working directory.

Returns: true for success or false for failure.

◆ chvol()

void FatVolume::chvol ( )

inline

Change global current working volume to this volume.

◆ cwv()

static FatVolume * FatVolume::cwv ( )

inlinestaticprivate

◆ exists() [1/2]

bool FatVolume::exists ( const char * path )

inline

Test for the existence of a file.

Parameters

[in] path Path of the file to be tested for.

Returns: true if the file exists else false.

◆ exists() [2/2]

bool FatVolume::exists ( const String & path )

inline

Test for the existence of a file.

Parameters

[in] path Path of the file to be tested for.

Returns: true if the file exists else false.

◆ ls() [1/4]

bool FatVolume::ls	(	const char *	path,
		uint8_t	flags = `0`
	)

inline

List the directory contents of a directory to Serial.

Parameters

[in]	path	directory to list.
[in]	flags	The inclusive OR of

LS_DATE - Print file modification date

LS_SIZE - Print file size.

LS_R - Recursive list of subdirectories.

Returns: true for success or false for failure.

◆ ls() [2/4]

bool FatVolume::ls	(	print_t *	pr,
		const char *	path,
		uint8_t	flags
	)

inline

List the contents of a directory.

Parameters

[in]	pr	Print stream for list.
[in]	path	directory to list.
[in]	flags	The inclusive OR of

LS_DATE - Print file modification date

LS_SIZE - Print file size.

LS_R - Recursive list of subdirectories.

Returns: true for success or false for failure.

◆ ls() [3/4]

bool FatVolume::ls	(	print_t *	pr,
		uint8_t	flags = `0`
	)

inline

List the directory contents of the volume root directory.

Parameters

[in]	pr	Print stream for list.
[in]	flags	The inclusive OR of

LS_DATE - Print file modification date

LS_SIZE - Print file size.

LS_R - Recursive list of subdirectories.

Returns: true for success or false for failure.

◆ ls() [4/4]

bool FatVolume::ls ( uint8_t flags = 0 )

inline

List the directory contents of the root directory to Serial.

Parameters

[in] flags The inclusive OR of

LS_DATE - Print file modification date

LS_SIZE - Print file size.

LS_R - Recursive list of subdirectories.

Returns: true for success or false for failure.

◆ mkdir() [1/2]

bool FatVolume::mkdir	(	const char *	path,
		bool	pFlag = `true`
	)

inline

Make a subdirectory in the volume root directory.

Parameters

[in]	path	A path with a valid name for the subdirectory.
[in]	pFlag	Create missing parent directories if true.

Returns: true for success or false for failure.

◆ mkdir() [2/2]

bool FatVolume::mkdir	(	const String &	path,
		bool	pFlag = `true`
	)

inline

Make a subdirectory in the volume root directory.

Parameters

[in]	path	A path with a valid name for the subdirectory.
[in]	pFlag	Create missing parent directories if true.

Returns: true for success or false for failure.

◆ open() [1/2]

File32 FatVolume::open	(	const char *	path,
		oflag_t	oflag = `O_RDONLY`
	)

inline

open a file

Parameters

[in]	path	location of file to be opened.
[in]	oflag	open flags.

Returns: a File32 object.

◆ open() [2/2]

File32 FatVolume::open	(	const String &	path,
		oflag_t	oflag = `O_RDONLY`
	)

inline

open a file

Parameters

[in]	path	location of file to be opened.
[in]	oflag	open flags.

Returns: a File32 object.

◆ remove() [1/2]

bool FatVolume::remove ( const char * path )

inline

Remove a file from the volume root directory.

Parameters

[in] path A path with a valid name for the file.

Returns: true for success or false for failure.

◆ remove() [2/2]

bool FatVolume::remove ( const String & path )

inline

Remove a file from the volume root directory.

Parameters

[in] path A path with a valid name for the file.

Returns: true for success or false for failure.

◆ rename() [1/2]

bool FatVolume::rename	(	const char *	oldPath,
		const char *	newPath
	)

inline

Rename a file or subdirectory.

Parameters

[in]	oldPath	Path name to the file or subdirectory to be renamed.
[in]	newPath	New path name of the file or subdirectory.

The newPath object must not exist before the rename call.

The file to be renamed must not be open. The directory entry may be moved and file system corruption could occur if the file is accessed by a file object that was opened before the rename() call.

Returns: true for success or false for failure.

◆ rename() [2/2]

bool FatVolume::rename	(	const String &	oldPath,
		const String &	newPath
	)

inline

Rename a file or subdirectory.

Parameters

[in]	oldPath	Path name to the file or subdirectory to be renamed.
[in]	newPath	New path name of the file or subdirectory.

The newPath object must not exist before the rename call.

The file to be renamed must not be open. The directory entry may be moved and file system corruption could occur if the file is accessed by a file object that was opened before the rename() call.

Returns: true for success or false for failure.

◆ rmdir() [1/2]

bool FatVolume::rmdir ( const char * path )

inline

Remove a subdirectory from the volume's working directory.

Parameters

[in] path A path with a valid name for the subdirectory.

The subdirectory file will be removed only if it is empty.

Returns: true for success or false for failure.

◆ rmdir() [2/2]

bool FatVolume::rmdir ( const String & path )

inline

Remove a subdirectory from the volume's working directory.

Parameters

[in] path A path with a valid name for the subdirectory.

The subdirectory file will be removed only if it is empty.

Returns: true for success or false for failure.

◆ truncate() [1/2]

bool FatVolume::truncate	(	const char *	path,
		uint32_t	length
	)

inline

Truncate a file to a specified length. The current file position will be at the new EOF.

Parameters

[in]	path	A path with a valid name for the file.
[in]	length	The desired length for the file.

Returns: true for success or false for failure.

◆ truncate() [2/2]

bool FatVolume::truncate	(	const String &	path,
		uint32_t	length
	)

inline

Truncate a file to a specified length. The current file position will be at the new EOF.

Parameters

[in]	path	A path with a valid name for the file.
[in]	length	The desired length for the file.

Returns: true for success or false for failure.

◆ vwd()

FatFile * FatVolume::vwd ( )

inlineprivate

Member Data Documentation

◆ FatFile

friend FatVolume::FatFile

private

◆ m_cwv

FatVolume * FatVolume::m_cwv = nullptr

staticprivate

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

◆ m_vwd

FatFile FatVolume::m_vwd

private

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

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ begin()

◆ chdir() [1/3]

◆ chdir() [2/3]

◆ chdir() [3/3]

◆ chvol()

◆ cwv()

◆ exists() [1/2]

◆ exists() [2/2]

◆ ls() [1/4]

◆ ls() [2/4]

◆ ls() [3/4]

◆ ls() [4/4]

◆ mkdir() [1/2]

◆ mkdir() [2/2]

◆ open() [1/2]

◆ open() [2/2]

◆ remove() [1/2]

◆ remove() [2/2]

◆ rename() [1/2]

◆ rename() [2/2]

◆ rmdir() [1/2]

◆ rmdir() [2/2]

◆ truncate() [1/2]

◆ truncate() [2/2]

◆ vwd()

Member Data Documentation

◆ FatFile

◆ m_cwv

◆ m_vwd