PackageFileSystem¶

class PackageFileSystem final : public FileSystem

A FileSystem implementation that provides access to an Amplitude package file.

Functions¶

Name	Description
PackageFileSystem	Constructs a new `PackageFileSystem` instance.
~PackageFileSystem	Destroys the `PackageFileSystem` instance.
SetBasePath	@inherit
GetBasePath	@inherit
ResolvePath	@inherit
Exists	@inherit
IsDirectory	@inherit
Join	@inherit
OpenFile	@inherit
StartOpenFileSystem	@inherit
TryFinalizeOpenFileSystem	@inherit
StartCloseFileSystem	@inherit
TryFinalizeCloseFileSystem	@inherit
IsValid	Returns if the package file is valid and loaded.

Function Details¶

Exists ¶

[[nodiscard]] bool Exists(const AmOsString& path) const override

@inherit

GetBasePath ¶

[[nodiscard]] const AmOsString& GetBasePath() const override

@inherit

IsDirectory ¶

[[nodiscard]] bool IsDirectory(const AmOsString& path) const override

@inherit

IsValid ¶

[[nodiscard]] bool IsValid() const

Returns if the package file is valid and loaded.

Return: true if the package file is valid and loaded, false otherwise.

Join ¶

[[nodiscard]] AmOsString Join(const std::vector<AmOsString>& parts) const override

@inherit

OpenFile ¶

[[nodiscard]] std::shared_ptr<File> OpenFile(const AmOsString& path, eFileOpenMode mode = eFileOpenMode_Read) const override

@inherit