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.
Public Member Functions | Public Attributes | List of all members
Archive::ArchiveExtractFileResult Struct Reference

#include <ArchiveReaderAPI.h>

Public Member Functions

 operator bool () const
 

Public Attributes

AZ::IO::Path m_relativeFilePath
 The file path of the extracted file.
 
ArchiveFileToken m_filePathToken { InvalidArchiveFileToken }
 
Compression::CompressionAlgorithmId m_compressionAlgorithm { Compression::Uncompressed }
 The compression algorithm ID representing the compression algorithm used to store the file.
 
AZ::u64 m_uncompressedSize {}
 The uncompressed size of the removed file.
 
AZ::u64 m_compressedSize {}
 the compressed size of the extracted file
 
ArchiveHeader::TocOffsetU64 m_offset {}
 
AZ::Crc32 m_crc32 {}
 CRC32 checksum of the uncompressed file data.
 
AZStd::span< AZStd::byte > m_fileSpan
 
ResultOutcome m_resultOutcome
 Stores any error messages related to extraction of the file from the archive.
 

Detailed Description

Returns result data around operation of adding a stream of content data to an archive file

Member Function Documentation

◆ operator bool()

Archive::ArchiveExtractFileResult::operator bool ( ) const
inlineexplicit

returns if adding a stream of data to a file within the archive has succeeded it does by checking that the ArchiveFileToken != InvalidArchiveFileToken

Member Data Documentation

◆ m_filePathToken

ArchiveFileToken Archive::ArchiveExtractFileResult::m_filePathToken { InvalidArchiveFileToken }

Identifier token that allows for quicker lookup of the file in the mounted archive TOC for the ArchiveReader instance the file was extracted from

◆ m_fileSpan

AZStd::span<AZStd::byte> Archive::ArchiveExtractFileResult::m_fileSpan

Span which view of the extracted file data If the ArchiveReaderFileSettings specifies decompression should occur, Then the extracted file content will be the raw content

◆ m_offset

ArchiveHeader::TocOffsetU64 Archive::ArchiveExtractFileResult::m_offset {}

The raw offset of the file in the archive As the ArchiveHeader is 512-byte aligned to the beginning of the file this value is at least 512, NOTE: The TocOffsetU64 structure is used to enforce that the value is >= 512

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