VFSFile Class Reference

Arduino File support using std::fstream. More...

#include <VFSFile.h>

Inheritance diagram for VFSFile:

Public Member Functions
	VFSFile (const char *fn)
	VFSFile (const VFSFile &file)
virtual int	available () override
virtual int	availableForWrite ()
virtual bool	begin ()
void	close ()
virtual void	end ()
virtual void	flush () override
const char *	name () const
void	open (const char *name, FileMode mode=VFS_FILE_READ)
	operator bool ()
VFSFile &	operator= (VFSFile file)
virtual int	peek () override
size_t	position ()
virtual int	print (const char *str)
virtual int	print (int number)
virtual int	println (const char *str="")
virtual int	println (int number)
virtual int	read () override
virtual size_t	readBytes (uint8_t *data, size_t len) override
bool	seek (uint32_t pos)
bool	seek (uint32_t pos, SeekMode mode)
size_t	size () const
virtual size_t	write (const uint8_t *data, size_t len)
virtual size_t	write (int32_t value)
virtual void	write (uint8_t *str, int len)
virtual size_t	write (uint8_t value) override

Protected Attributes
int	_timeout = 10
const char *	file_path = nullptr
bool	is_read = true
std::fstream	stream

Detailed Description

Arduino File support using std::fstream.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

available()

virtual int available ( )

inlineoverridevirtual

Reimplemented from Stream.

availableForWrite()

virtual int availableForWrite ( )

inlinevirtualinherited

Reimplemented in RTSPOutput, UDPStream, A2DPStream, AudioFFTBase, I2SCodecStream, AbstractURLStream, URLStreamESP32, I2SStream, OutputMixer< T >, MeasuringStream, ProgressStream, and VolumeStream.

flush()

virtual void flush ( )

inlineoverridevirtual

Reimplemented from Print.

readBytes()

virtual size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtual

Reimplemented from Stream.

write()

virtual size_t write ( const uint8_t *  data, size_t  len  )

inlinevirtualinherited

Reimplemented in I2SCodecStream, MozziStream, SPDIFOutput, I2SStream, MetaDataOutput, EncodedAudioOutput, OggContainerOutput, A2DPStream, FaustStream< DSP >, AudioFFTBase, AudioServerEx, RTSPOutput, TfLiteAudioStream, VS1053Stream, ESPNowStream, UDPStream, AnalogAudioStream, AudioEffectStreamT< T >, HttpRequest, BufferedTaskStream, TimedStream, MetaDataFilter, CsvOutput< T >, OutputMixer< T >, BufferedStream, MeasuringStream, ProgressStream, VolumeStream, HDLCStream, TfLiteAudioStreamBase, CatStream, and AnalogDriverESP32V2::IO16Bit.

---

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

• src/AudioTools/Disk/VFSFile.h