wowlib::FileKey Struct Reference

#include <wowlib/core/file_key.hpp>

Public Member Functions
	FileKey ()=default
	FileKey (std::string_view filePath)
	FileKey (FileDataID fileId)
	An id-only key.
	FileKey (std::string_view filePath, FileDataID fileId)
	A key carrying both identities of one file.

Public Attributes
std::optional< FileDataID >	fdid
	The numeric identifier, if known.
std::optional< std::string >	path
	The canonical client-internal path, if known.

Detailed Description

Definition at line 26 of file file_key.hpp.

Constructor & Destructor Documentation

FileKey() [1/4]

wowlib::FileKey::FileKey ( )

default

FileKey() [2/4]

wowlib::FileKey::FileKey ( std::string_view filePath )

inline

Parameters

filePath

the client-internal file path

Definition at line 35 of file file_key.hpp.

References wowlib::normalizePath(), and path.

FileKey() [3/4]

wowlib::FileKey::FileKey ( FileDataID fileId )

inline

An id-only key.

Parameters

fileId

the numeric file identifier

Definition at line 40 of file file_key.hpp.

References fdid.

FileKey() [4/4]

wowlib::FileKey::FileKey ( std::string_view filePath, FileDataID fileId )

inline

A key carrying both identities of one file.

Parameters

filePath	the client-internal file path
fileId	the numeric file identifier

Definition at line 44 of file file_key.hpp.

References fdid, wowlib::normalizePath(), and path.

Member Data Documentation

fdid

std::optional<FileDataID> wowlib::FileKey::fdid

The numeric identifier, if known.

Definition at line 28 of file file_key.hpp.

Referenced by wowlib::fs::CascStorage::exists(), FileKey(), FileKey(), wowlib::fs::CascStorage::readFile(), and wowlib::fs::ClientFileSystem< MpqStorage, NullListfile >::resolve().

path

std::optional<std::string> wowlib::FileKey::path

The canonical client-internal path, if known.

Definition at line 31 of file file_key.hpp.

Referenced by wowlib::fs::CascStorage::exists(), wowlib::fs::ClientFileSystem< MpqStorage, NullListfile >::exists(), wowlib::fs::MpqStorage::exists(), FileKey(), FileKey(), wowlib::formats::adt::detail::ADT< V >::read(), wowlib::formats::wdt::detail::WDT< V >::read(), wowlib::formats::wmo::detail::WMO< V >::read(), wowlib::fs::CascStorage::readFile(), wowlib::fs::ClientFileSystem< MpqStorage, NullListfile >::readFile(), wowlib::fs::MpqStorage::readFile(), wowlib::fs::ClientFileSystem< MpqStorage, NullListfile >::resolve(), wowlib::db::TableCore::write(), wowlib::formats::adt::detail::ADT< V >::write(), wowlib::formats::blp::BLP::write(), wowlib::formats::m2::detail::M2< V >::write(), wowlib::formats::m2::detail::Skeleton< V >::write(), wowlib::formats::wdl::detail::WDL< V >::write(), wowlib::formats::wdt::detail::WDT< V >::write(), and wowlib::formats::wmo::detail::WMO< V >::write().

---

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

• src/wowlib/core/file_key.hpp