Open 3D Engine Archive Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Archive::ArchiveTableOfContentsView Struct Reference

#include <ArchiveTOCView.h>

Public Types

using CreateTOCViewOutcome = AZStd::expected< ArchiveTableOfContentsView, ArchiveTocValidationResult >
 
using ArchiveFilePathTable = AZStd::string_view
 ArchiveFilePathTable is a view into the start of the blob for file paths.
 

Public Member Functions

 ArchiveTableOfContentsView ()
 ArchiveTableOfContentsView member implementation.
 

Static Public Member Functions

static CreateTOCViewOutcome CreateFromArchiveHeaderAndBuffer (const ArchiveHeader &archiveHeader, AZStd::span< AZStd::byte > tocBuffer)
 

Public Attributes

AZ::u64 m_magicBytes = ArchiveTocMagicBytes
 8-byte magic bytes entry used to indicate that the read table of contents is valid
 
AZStd::span< ArchiveTocFileMetadata const > m_fileMetadataTable {}
 
AZStd::span< ArchiveTocFilePathIndex const > m_filePathIndexTable {}
 
ArchiveFilePathTable m_filePathBlob {}
 
AZStd::span< ArchiveBlockLineUnion const > m_blockOffsetTable {}
 pointer to block offset table which stores the compressed size of all blocks within the archive
 

Detailed Description

View Structure for viewing the Table of Contents at the end of the archive file This structure does not own the table of contents data in memory

Member Typedef Documentation

◆ CreateTOCViewOutcome

Initializes a Table of Contents view using the archive header and a buffer containing the uncompressed table of contents data from storage

Member Data Documentation

◆ m_fileMetadataTable

AZStd::span<ArchiveTocFileMetadata const> Archive::ArchiveTableOfContentsView::m_fileMetadataTable {}

pointer to the beginning of the Archive File Metadata Table It's length is based on the file count value in the Archive Header Section

◆ m_filePathIndexTable

AZStd::span<ArchiveTocFilePathIndex const> Archive::ArchiveTableOfContentsView::m_filePathIndexTable {}

pointer to the beginning of the Archive File Path Index Table It's length is based on the file count value in the Archive Header Section


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