Main

Typedefs
using	nnl::dig_entry::DigEntry = std::vector<Buffer>
	A nested archive within a top-level Dig archive.
using	nnl::dig_entry::DigEntryView = std::vector<BufferView>
	A non-owning view of a dig entry archive.

Functions
bool	nnl::dig_entry::IsOfType (BufferView buffer)
	Tests if the provided file is a dig entry archive.
DigEntry	nnl::dig_entry::Import (BufferView buffer)
	Parses a binary file and converts it into a DigEntry object.
DigEntryView	nnl::dig_entry::ImportView (BufferView buffer)
	Parses a binary file and converts it into DigEntryView.
Buffer	nnl::dig_entry::Export (const DigEntry &dig_entry)
	Converts a dig entry archive to a binary file representation.

Detailed Description

Typedef Documentation

DigEntry

using nnl::dig_entry::DigEntry = std::vector<Buffer>

A nested archive within a top-level Dig archive.

See also

nnl::dig_entry::Import

nnl::dig_entry::Export

nnl::dig_entry::DigEntryView

nnl::dig::FileRecord

DigEntryView

using nnl::dig_entry::DigEntryView = std::vector<BufferView>

A non-owning view of a dig entry archive.

This type is almost identical to DigEntry and represents the same archive but allows for access to its entries via references to the source Buffer. It's most suitable when no modifications to the data are expected.

See also

nnl::dig_entry::DigEntry

nnl::dig_entry::ImportView

Function Documentation

Export()

Buffer nnl::dig_entry::Export ( const DigEntry & dig_entry )

nodiscard

Converts a dig entry archive to a binary file representation.

This function takes an dig entry archive and converts it into a Buffer, which represents the binary format of the container.

Parameters

dig_entry

The object to be converted.

Returns

A Buffer containing the binary representation of the container.

Import()

DigEntry nnl::dig_entry::Import

(

BufferView

buffer

)

Parses a binary file and converts it into a DigEntry object.

This function takes a binary representation of a dig entry archive, parses its contents, and converts them into a DigEntry object for easier access and modification.

Parameters

buffer

The binary data to be processed.

Returns

A DigEntry object.

Note

The entries of a dig archive may be compressed and require decompression before they can be imported.

See also

nnl::dig::Decompress

nnl::dig_entry::IsOfType

nnl::dig_entry::ImportView

nnl::dig_entry::Export

ImportView()

DigEntryView nnl::dig_entry::ImportView

(

BufferView

buffer

)

Parses a binary file and converts it into DigEntryView.

DigEntryView does not store copies of file buffers but stores references to the original data.

Parameters

buffer

The binary data to be processed.

Returns

An DigEntryView object representing the converted data.

Note

The entries of a dig archive may be compressed and require decompression before they can be imported.

See also

nnl::dig::Decompress

nnl::dig_entry::IsOfType

nnl::dig_entry::Export

IsOfType()

bool nnl::dig_entry::IsOfType

(

BufferView

buffer

)

Tests if the provided file is a dig entry archive.

This function takes data representing a file and checks whether it corresponds to the in-game dig entry archive format.

Parameters

buffer

The data to be tested.

Returns

true if the file is identified as a dig entry archive.

Note

The entries of a dig archive may be compressed and require decompression before they can be accessed.

See also

nnl::dig::Decompress

nnl::dig_entry::Import

nnl::dig_entry::ImportView