Represents the header of a data file used in the serialization process. More...

#include <datafile.hpp>

Public Attributes
char	magic [4] = {'F', 'O', 'U', 'N'}
	Magic identifier used to validate file type.

uint32_t	version = 1U
	Version of the file format.

uint32_t	num_positions
	Number of position entries (Vec3 elements) in the file.

uint32_t	crc
	CRC32 checksum of the header (excluding this field) for validation.

Detailed Description

Represents the header of a data file used in the serialization process.

Contains metadata such as a magic identifier, version, number of position records, and a CRC32 checksum for integrity verification.

Member Data Documentation

◆ crc

uint32_t found::DataFileHeader::crc

CRC32 checksum of the header (excluding this field) for validation.

◆ magic

char found::DataFileHeader::magic[4] = {'F', 'O', 'U', 'N'}

Magic identifier used to validate file type.

The magic string "FOUN" is used to identify this file format during deserialization. This is similar to other file formats (e.g., PNG, PDF) that include a recognizable signature at the start of the file. If the magic value doesn't match, the file is considered invalid or corrupted.

◆ num_positions

uint32_t found::DataFileHeader::num_positions

Number of position entries (Vec3 elements) in the file.

◆ version

uint32_t found::DataFileHeader::version = 1U

Version of the file format.

Default is 1. Used to support versioned deserialization in the future.

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