Cpl::Io::File Namespace Reference

The File namespace provides the base/common interfaces for reading and writing data from/to Files. More...

Detailed Description

The File namespace provides the base/common interfaces for reading and writing data from/to Files.

Note: The underlying implementation for reading/writing files is defined by which implementation the Application selects (i.e. compiles & links) for the Cpl::Io::Stdio namespace.

Namespaces
namespace	Arduino
	The Arduino namespace provides an interface for Arduino boards that support a 'file system'.
namespace	Littlefs
	The 'Littlefs' namespace implements the CPL file abstractions using the open source 'littlefs' file system (https://github.com/littlefs-project/littlefs)

Classes
class	Api
	This concrete class defines the interface for handling and manipulating entries in the System's File system. More...
class	Common_
	This private concrete class is a helper class that implements the common functions for the handling files. More...
class	DirList_
	This private concrete does the work for Api::walkDirectory() method. More...
class	Input
	This concrete class provides a platform independent 'standard' implementation of a Cpl::Io::File::Input object. More...
class	InputApi
	This abstract class defines the interface for a Random Access Input File. More...
class	InputOutput
	This concrete class provides a platform independent 'standard' implementation of an InputOutputFileApi object. More...
class	InputOutputApi
	This abstract class defines the interface for a Random Access Input Output File. More...
class	Null
	This concrete class implements a NULL InputOutputApi File that all of its input operations return 'End-of-File' (i.e. More...
class	ObjectApi
	This abstract class defines the basic additional functionality, beyond that of a stream, for a file. More...
class	Output
	This concrete class provides a platform independent 'standard' implementation of a Cpl::Io::File::Output object. More...
class	OutputApi
	This abstract class defines the interface for a Random Access Input File. More...

Typedefs
typedef Cpl::Text::FString< CPL_IO_FILE_MAX_NAME >	NameString
	This typed FString is guaranteed to be large enough to hold the maximum allowed file system name for the native OS/Platform.

Functions
bool	calcMD5Checksum (const char *fullPathName, Cpl::Checksum::ApiMd5::Digest_T dstDigest, Cpl::Text::String *dstString=nullptr, size_t *dstFileLen=nullptr)
	This method calculates the MD5 Checksum of the specified file.

Typedef Documentation

NameString

typedef Cpl::Text::FString<CPL_IO_FILE_MAX_NAME> Cpl::Io::File::NameString

This typed FString is guaranteed to be large enough to hold the maximum allowed file system name for the native OS/Platform.

Function Documentation

calcMD5Checksum()

bool Cpl::Io::File::calcMD5Checksum	(	const char *	fullPathName,
		Cpl::Checksum::ApiMd5::Digest_T	dstDigest,
		Cpl::Text::String *	dstString = nullptr,
		size_t *	dstFileLen = nullptr
	)

This method calculates the MD5 Checksum of the specified file.

The method returns true when successful. The caller is required to provide memory for 'dstDigest'

When 'dstString' is non null, the checksum as a ASCII HEX string is returned.

When 'dstFileLen' is non null, the length (in bytes) of the file is returned.