#include <ArchiveReaderAPI.h>

Public Attributes
AZStd::variant< AZ::IO::PathView, ArchiveFileToken >	m_filePathIdentifier

bool	m_decompressFile { true }

const Compression::DecompressionOptions *	m_decompressionOptions {}

AZ::u64	m_startOffset {}
	Offset within the file being extracted to start reading.

AZ::u64	m_bytesToRead { AZStd::numeric_limits<AZ::u64>::max() }

Detailed Description

Settings for controlling how an individual file is extracted from an archive. It supports specifying custom decompression options that is forwarded to the registered IDecompressionInterface used to decompress the file if it is compressed

Member Data Documentation

◆ m_bytesToRead

AZ::u64 Archive::ArchiveReaderFileSettings::m_bytesToRead { AZStd::numeric_limits<AZ::u64>::max() }

The amount of bytes to read from the extracted file Defaults to AZStd::numeric_limits<AZ::u64>::max() which is used as sentinel value to indicate the entire file should be read

◆ m_decompressFile

bool Archive::ArchiveReaderFileSettings::m_decompressFile { true }

Decompress the file content if compressed By default, a compressed content will be decompressed after being read from the Archive file

◆ m_decompressionOptions

const Compression::DecompressionOptions* Archive::ArchiveReaderFileSettings::m_decompressionOptions {}

Pointer to a decompression options derived struct This can be used to supply custom decompression options

◆ m_filePathIdentifier

AZStd::variant<AZ::IO::PathView, ArchiveFileToken> Archive::ArchiveReaderFileSettings::m_filePathIdentifier

Variant which stores either a path view or an ArchiveFileToken It is used to supply the identifier that can be used to query the file contents

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