Components/IFS/src/include/IFS/FWFS/ArchiveStream.h
Go to the documentation of this file.
131 ArchiveStream(FileSystem* fileSystem, VolumeInfo volumeInfo, String rootPath = nullptr, Flags flags = 0)
String name
Volume Name.
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:62
Virtual base class to support (file) data encryption and compression.
Definition: BlockEncoder.h:39
VolumeInfo & operator=(const IFileSystem::Info &fsinfo)
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:66
const char * c_str() const
Get a constant (un-modifiable) pointer to String content.
Definition: WString.h:641
Passed to callbacks to allow modification of output data.
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:78
const FileHandle handle
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:114
MimeType getMimeType() const override
Get MIME type for stream content.
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:193
void onFilterStat(FilterStatCallback callback)
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:153
bool isSuccess() const
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:198
Flag
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:55
~ArchiveStream()
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:136
bool isFinished() override
Check if all data has been read.
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:188
Definition: DirectoryTemplate.h:36
FileInfo(ArchiveStream &stream, DirInfo &dir, FileHandle handle, const Stat &stat)
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:81
Class to manage writing object data into a stream.
Definition: ObjectBuffer.h:32
void onCreateEncoder(CreateEncoderCallback callback)
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:171
uint16_t readMemoryBlock(char *data, int bufSize) override
Read a block of memory.
size_t length(void) const
Obtain the String length in characters, excluding NUL terminator.
Definition: WString.h:237
Implementation of firmware filing system using IFS.
Definition: Components/IFS/src/include/IFS/FWFS/FileSystem.h:96
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:61
const Stat & stat
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:115
virtual bool filterStat(const Stat &stat)
Override this method to filter items.
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:148
virtual IBlockEncoder * createEncoder(FileInfo &file)
Override this method to implement custom encoding such as compression or encryption.
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:166
uint32_t volumeID
Unique identifier for volume.
Definition: IFileSystem.h:124
FileSystem * getFileSystem() const
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:86
int seekFrom(int offset, SeekOrigin origin) override
Change position in stream.
const String & getCurrentPath() const
Get the current path being processed.
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:179
Supports direct streaming into FWFS archive format.
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:50
int setAttribute(AttributeTag tag, const String &data)
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:101
Set to include mountpoints in archive.
int setUserAttribute(uint8_t tagValue, ParamTypes... params)
Set an additional user attribute.
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:109
ArchiveStream(FileSystem *fileSystem, VolumeInfo volumeInfo, String rootPath=nullptr, Flags flags=0)
Construct an archive stream.
Definition: Components/IFS/src/include/IFS/FWFS/ArchiveStream.h:131
Definition: FsBase.h:33