psyqo::paths::ArchiveManager::IndexEntry Union Reference

The IndexEntry struct represents an entry in the archive index. More...

#include <psyqo-paths/archive-manager.hh>

Collaboration diagram for psyqo::paths::ArchiveManager::IndexEntry:

Public Types
enum class	Method : uint32_t { NONE = 0 , UCL_NRV2E = 1 , LZ4 = 2 , COUNT = 3 }
typedef Utilities::BitSpan< uint32_t, 21 >	DecompSizeField
typedef Utilities::BitSpan< uint32_t, 11 >	PaddingField
typedef Utilities::BitSpan< uint32_t, 19 >	SectorOffsetField
typedef Utilities::BitSpan< uint32_t, 10 >	CompressedSizeField
typedef Utilities::BitSpan< Method, 3 >	MethodField
typedef Utilities::BitField< DecompSizeField, PaddingField, SectorOffsetField, CompressedSizeField, MethodField >	CompressedEntry

Public Member Functions
uint32_t	getDecompSize () const
uint32_t	getPadding () const
uint32_t	getSectorOffset () const
uint32_t	getCompressedSize () const
Method	getCompressionMethod () const

Public Attributes
uint32_t	asArray [4]
struct {
uint64_t   hash
CompressedEntry   entry
};

Detailed Description

The IndexEntry struct represents an entry in the archive index.

The IndexEntry struct contains information about a file in the archive, including its hash, decompressed size, padding size, sector offset, compressed size, and compression method. While technically used by the archive manager itself, the user can also use this struct to access the information about the file in the archive and make decisions based on it.

Member Typedef Documentation

CompressedEntry

typedef Utilities::BitField<DecompSizeField, PaddingField, SectorOffsetField, CompressedSizeField, MethodField> psyqo::paths::ArchiveManager::IndexEntry::CompressedEntry

CompressedSizeField

typedef Utilities::BitSpan<uint32_t, 10> psyqo::paths::ArchiveManager::IndexEntry::CompressedSizeField

DecompSizeField

typedef Utilities::BitSpan<uint32_t, 21> psyqo::paths::ArchiveManager::IndexEntry::DecompSizeField

MethodField

typedef Utilities::BitSpan<Method, 3> psyqo::paths::ArchiveManager::IndexEntry::MethodField

PaddingField

typedef Utilities::BitSpan<uint32_t, 11> psyqo::paths::ArchiveManager::IndexEntry::PaddingField

SectorOffsetField

typedef Utilities::BitSpan<uint32_t, 19> psyqo::paths::ArchiveManager::IndexEntry::SectorOffsetField

Member Enumeration Documentation

Method

enum class psyqo::paths::ArchiveManager::IndexEntry::Method : uint32_t

strong

Enumerator
NONE
UCL_NRV2E
LZ4
COUNT

Member Function Documentation

getCompressedSize()

uint32_t psyqo::paths::ArchiveManager::IndexEntry::getCompressedSize ( ) const

inline

getCompressionMethod()

Method psyqo::paths::ArchiveManager::IndexEntry::getCompressionMethod ( ) const

inline

getDecompSize()

uint32_t psyqo::paths::ArchiveManager::IndexEntry::getDecompSize ( ) const

inline

getPadding()

uint32_t psyqo::paths::ArchiveManager::IndexEntry::getPadding ( ) const

inline

getSectorOffset()

uint32_t psyqo::paths::ArchiveManager::IndexEntry::getSectorOffset ( ) const

inline

Member Data Documentation

[struct]

struct { ... } psyqo::paths::ArchiveManager::IndexEntry

asArray

uint32_t psyqo::paths::ArchiveManager::IndexEntry::asArray[4]

entry

CompressedEntry psyqo::paths::ArchiveManager::IndexEntry::entry

hash

uint64_t psyqo::paths::ArchiveManager::IndexEntry::hash

---

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

• psyqo-paths/archive-manager.hh