AnyFile

#include <Media/AnyFile.h>

class AnyFile

Defined in Media/AnyFile.h:24

Base class of all files that can be loaded or saved.

Public Attributes

Return	Name	Description
fs::path	path	The location of this file (may be empty).
utl::Buffer< u8 >	data	The raw data of this file.

---

path

fs::path path

Defined in Media/AnyFile.h:29

The location of this file (may be empty).

---

data

utl::Buffer< u8 > data

Defined in Media/AnyFile.h:32

The raw data of this file.

Public Methods

Return	Name	Description
void	init	Initializes the file with an empty buffer of the given capacity.
void	init	Initializes the file with the contents of a memory region.
void	init	Initializes the file with the contents of a buffer.
void	init	Initializes the file with the contents of a string.
void	init	Initializes the file with the contents of a file.
u64	hash const inline override	Returns a fingerprint (hash value) for this file.
Dumpable::DataProvider	dataProvider const inline override	Returns a data provider for dumping the file contents.
isize	getSize const inline	Returns the size of this file.
u8 *	getData const inline	Returns a pointer to the file data.
bool	empty const inline	Returns true if the file contains no data.
std::vector< string >	describe virtual const inline	Returns meta-information about the file.
utl::ByteView	byteView const	Returns a read-only view of the file contents, starting at an offset.
utl::ByteView	byteView const	Returns a read-only view of a portion of the file contents.
utl::MutableByteView	byteView	Returns a mutable view of the file contents, starting at an offset.
utl::MutableByteView	byteView	Returns a mutable view of a portion of the file contents.
void	copy virtual const	Copies a portion of the file contents into a buffer.
void	copy virtual const	Copies the file contents (starting at an offset) into a buffer.
bool	isCompatiblePath virtual const inline	Returns true if path points to a compatible file.
isize	writeToStream const	Writes the file to a stream.
isize	writeToStream const	Writes a portion of the file to a stream.
isize	writeToFile const	Writes the file to a file on disk.
isize	writeToFile const	Writes a portion of the file to a file on disk.

---

init

void init(isize len)

Defined in Media/AnyFile.h:44

Initializes the file with an empty buffer of the given capacity.

---

init

void init(const u8 * buf, isize len)

Defined in Media/AnyFile.h:46

Initializes the file with the contents of a memory region.

---

init

void init(const utl::Buffer< u8 > & buffer)

Defined in Media/AnyFile.h:48

Initializes the file with the contents of a buffer.

---

init

void init(const string & str)

Defined in Media/AnyFile.h:50

Initializes the file with the contents of a string.

---

init

void init(const fs::path & path)

Defined in Media/AnyFile.h:52

Initializes the file with the contents of a file.

---

hash

const inline override

inline u64 hash(HashAlgorithm algorithm) const override

Defined in Media/AnyFile.h:62

Returns a fingerprint (hash value) for this file.

---

dataProvider

const inline override

inline Dumpable::DataProvider dataProvider() const override

Defined in Media/AnyFile.h:74

Returns a data provider for dumping the file contents.

---

getSize

const inline

inline isize getSize() const

Defined in Media/AnyFile.h:86

Returns the size of this file.

---

getData

const inline

inline u8 * getData() const

Defined in Media/AnyFile.h:88

Returns a pointer to the file data.

---

empty

const inline

inline bool empty() const

Defined in Media/AnyFile.h:90

Returns true if the file contains no data.

---

describe

virtual const inline

virtual inline std::vector< string > describe() const

Defined in Media/AnyFile.h:93

Returns meta-information about the file.

---

byteView

const

utl::ByteView byteView(isize offset = 0) const

Defined in Media/AnyFile.h:103

Returns a read-only view of the file contents, starting at an offset.

---

byteView

const

utl::ByteView byteView(isize offset, isize len) const

Defined in Media/AnyFile.h:105

Returns a read-only view of a portion of the file contents.

---

byteView

utl::MutableByteView byteView(isize offset = 0)

Defined in Media/AnyFile.h:107

Returns a mutable view of the file contents, starting at an offset.

---

byteView

utl::MutableByteView byteView(isize offset, isize len)

Defined in Media/AnyFile.h:109

Returns a mutable view of a portion of the file contents.

---

copy

virtual const

virtual void copy(u8 * dst, isize offset, isize len) const

Defined in Media/AnyFile.h:113

Copies a portion of the file contents into a buffer.

---

copy

virtual const

virtual void copy(u8 * dst, isize offset = 0) const

Defined in Media/AnyFile.h:115

Copies the file contents (starting at an offset) into a buffer.

---

isCompatiblePath

virtual const inline

virtual inline bool isCompatiblePath(const fs::path & path) const

Defined in Media/AnyFile.h:123

Returns true if path points to a compatible file.

Reimplemented by

• Snapshot::isCompatiblePath

---

writeToStream

const

isize writeToStream(std::ostream & stream) const

Defined in Media/AnyFile.h:133

Writes the file to a stream.

---

writeToStream

const

isize writeToStream(std::ostream & stream, isize offset, isize len) const

Defined in Media/AnyFile.h:138

Writes a portion of the file to a stream.

---

writeToFile

const

isize writeToFile(const fs::path & path) const

Defined in Media/AnyFile.h:135

Writes the file to a file on disk.

---

writeToFile

const

isize writeToFile(const fs::path & path, isize offset, isize len) const

Defined in Media/AnyFile.h:140

Writes a portion of the file to a file on disk.