VFSFile Class Reference

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

#include <VFSFile.h>

Inheritance diagram for VFSFile:

Public Member Functions
	VFSFile ()=default
	VFSFile (const char *fn)
	VFSFile (const VFSFile &file)
	~VFSFile ()
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 size_t	print (const char *str)
virtual size_t	print (int number)
virtual size_t	println (const char *str="")
virtual size_t	println (int number)
virtual int	read () override
virtual size_t	readBytes (char *data, size_t len)
virtual size_t	readBytes (uint8_t *data, size_t len)
bool	seek (uint32_t pos)
bool	seek (uint32_t pos, SeekMode mode)
size_t	size () const
virtual size_t	write (const uint8_t *str, size_t len) override
virtual size_t	write (int32_t value)
virtual size_t	write (uint8_t *str, size_t 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

Constructor & Destructor Documentation

VFSFile() [1/3]

VFSFile ( )

default

VFSFile() [2/3]

VFSFile ( const char *  fn )

inline

VFSFile() [3/3]

VFSFile ( const VFSFile &  file )

inline

~VFSFile()

~VFSFile ( )

inline

Member Function Documentation

available()

virtual int available ( )

inlineoverridevirtual

Reimplemented from Stream.

availableForWrite()

virtual int availableForWrite ( )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, AudioLoRa, RTSPOutput< Platform >, SPIAudioMaster, UDPStream, VBANStream, AudioStreamWrapper, ConverterStream< T >, EncodedAudioOutput, EncodedAudioStream, FaustStream< DSP >, FileOutput, I2SCodecStream, MiniAudioStream, StdioStream, A2DPStream, AudioServerEx, AudioSyncWriter, ESPNowStream, HammingFEC< bytecount, block_t >, AbstractURLStream, URLStreamESP32, NRF24Stream, ReadioHeadStream, ReedSolomonFEC< bytecount, additional_bytes >, SPIAudioSlave, USBAudioDeviceBase, SynchronizedStream, AnalogAudioStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, ReformatBaseStream, AdapterAudioStreamToAudioOutput, TimedStream, AudioOutput, CsvOutput< T >, OutputMixer< T >, MemoryOutput, PWMAudioOutput< PWMDriverT >, MemoryStream, RingBufferStream, MeasuringStream, ProgressStream, Throttle, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, BaseStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, Pipeline, QualityAnalysisStream, VolumeStream, AudioFFTBase, AudioBLEClient, AudioBLEClient, AudioBLEServer, and AudioBLEServer.

begin()

virtual bool begin ( )

inlinevirtual

close()

void close ( )

inline

end()

virtual void end ( )

inlinevirtual

flush()

virtual void flush ( )

inlineoverridevirtual

Reimplemented from Print.

name()

const char * name ( ) const

inline

open()

void open ( const char *  name, FileMode  mode = VFS_FILE_READ  )

inline

operator bool()

operator bool ( )

inline

operator=()

VFSFile & operator= ( VFSFile  file )

inline

peek()

virtual int peek ( )

inlineoverridevirtual

position()

size_t position ( )

inline

print() [1/2]

virtual size_t print ( const char *  str )

inlinevirtual

print() [2/2]

virtual size_t print ( int  number )

inlinevirtual

println() [1/2]

virtual size_t println ( const char *  str = "" )

inlinevirtual

println() [2/2]

virtual size_t println ( int  number )

inlinevirtual

read()

virtual int read ( )

inlineoverridevirtual

readBytes() [1/2]

virtual size_t readBytes ( char *  data, size_t  len  )

inlinevirtual

readBytes() [2/2]

virtual size_t readBytes ( uint8_t *  data, size_t  len  )

inlinevirtual

Reimplemented from Stream.

seek() [1/2]

bool seek ( uint32_t  pos )

inline

seek() [2/2]

bool seek ( uint32_t  pos, SeekMode  mode  )

inline

size()

size_t size ( ) const

inline

write() [1/4]

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

inlineoverridevirtual

Reimplemented from Print.

write() [2/4]

virtual size_t write ( int32_t  value )

inlinevirtual

write() [3/4]

virtual size_t write ( uint8_t *  str, size_t  len  )

inlinevirtual

write() [4/4]

virtual size_t write ( uint8_t  value )

inlineoverridevirtual

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

file_path

const char* file_path = nullptr

protected

is_read

bool is_read = true

protected

stream

std::fstream stream

protected

---

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

• src/AudioTools/Disk/VFSFile.h