IFS::FWFS::ArchiveStream::FileInfo Class Reference

Passed to callbacks to allow modification of output data. More...

#include <ArchiveStream.h>

Collaboration diagram for IFS::FWFS::ArchiveStream::FileInfo:
[legend]

Public Member Functions

 FileInfo (ArchiveStream &stream, DirInfo &dir, FileHandle handle, const Stat &stat)
 
FileSystemgetFileSystem () const
 
int setAttribute (AttributeTag tag, const void *data, size_t size)
 Set an additional attribute on the file. More...
 
int setAttribute (AttributeTag tag, const String &data)
 
template<typename... ParamTypes>
int setUserAttribute (uint8_t tagValue, ParamTypes... params)
 Set an additional user attribute. More...
 

Public Attributes

const FileHandle handle
 
const Statstat
 

Detailed Description

Passed to callbacks to allow modification of output data.

Constructor & Destructor Documentation

◆ FileInfo()

IFS::FWFS::ArchiveStream::FileInfo::FileInfo ( ArchiveStream stream,
DirInfo &  dir,
FileHandle  handle,
const Stat stat 
)
inline

Member Function Documentation

◆ getFileSystem()

FileSystem* IFS::FWFS::ArchiveStream::FileInfo::getFileSystem ( ) const
inline

◆ setAttribute() [1/2]

int IFS::FWFS::ArchiveStream::FileInfo::setAttribute ( AttributeTag  tag,
const void *  data,
size_t  size 
)

Set an additional attribute on the file.

These are written out before existing file metadata is copied, so will take priority. For example, if we set the compression attribute here then that is the one which the filesystem will use when mounted. However, the original compression attribute will still be present which may be helpful.

◆ setAttribute() [2/2]

int IFS::FWFS::ArchiveStream::FileInfo::setAttribute ( AttributeTag  tag,
const String data 
)
inline

◆ setUserAttribute()

template<typename... ParamTypes>
int IFS::FWFS::ArchiveStream::FileInfo::setUserAttribute ( uint8_t  tagValue,
ParamTypes...  params 
)
inline

Set an additional user attribute.

Member Data Documentation

◆ handle

const FileHandle IFS::FWFS::ArchiveStream::FileInfo::handle

◆ stat

const Stat& IFS::FWFS::ArchiveStream::FileInfo::stat

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