ChunkHeader

Struct ChunkHeader 

Source
pub struct ChunkHeader {
    pub id: ChunkId,
    pub size: u32,
}
Expand description

Standard ADT chunk header (8 bytes)

All chunks in ADT files follow this structure:

  • 4 bytes: Magic identifier (reversed string, e.g., “MVER” stored as [0x52, 0x45, 0x56, 0x4D])
  • 4 bytes: Data size (little-endian u32, excludes the 8-byte header)

§Binary Layout

Offset | Size | Field | Description
-------|------|-------|------------------------------------------
0x00   |  4   | id    | Chunk magic identifier (reversed)
0x04   |  4   | size  | Data size in bytes (excludes header)

§Example

File bytes: [0x52, 0x45, 0x56, 0x4D] [0x04, 0x00, 0x00, 0x00] [0x12, 0x00, 0x00, 0x00]
            └────── "REVM" ────────┘ └──── size: 4 ────────┘ └─── version data ──┘
            (displays as "MVER")

§Size Field Semantics

The size field represents the byte count of chunk data EXCLUDING the 8-byte header. This is a common source of off-by-8 errors when calculating file offsets.

If size = 100, then:

  • Chunk data occupies bytes [8..108] relative to chunk start
  • Total chunk size (header + data) = 108 bytes
  • Next chunk starts at offset 108

§Usage with binrw

use binrw::BinRead;
use std::io::Cursor;
use wow_adt::chunk_header::ChunkHeader;

let data = [0x52, 0x45, 0x56, 0x4D, 0x04, 0x00, 0x00, 0x00];
let mut cursor = Cursor::new(&data);

let header = ChunkHeader::read(&mut cursor)?;
assert_eq!(header.size, 4);
assert_eq!(header.total_size(), 12); // 8-byte header + 4 bytes data

Fields§

§id: ChunkId

Chunk magic identifier (4 bytes, reversed)

Identifiers are stored in reverse byte order. For example, the “MVER” chunk is stored as [0x52, 0x45, 0x56, 0x4D] (“REVM” in ASCII).

§size: u32

Size of chunk data in bytes (excludes 8-byte header)

This field specifies the size of the chunk data following the header. The total chunk size is size + 8 bytes.

Implementations§

Source§

impl ChunkHeader

Source

pub const fn total_size(&self) -> u64

Total size including header (size + 8)

Returns the complete chunk size including the 8-byte header. Use this when calculating file offsets to the next chunk.

§Example
use wow_adt::chunk_header::ChunkHeader;
use wow_adt::chunk_id::ChunkId;

let header = ChunkHeader {
    id: ChunkId::from_str("MVER").unwrap(),
    size: 100,
};

assert_eq!(header.total_size(), 108); // 100 + 8
Source

pub fn is_chunk(&self, expected: ChunkId) -> bool

Check if chunk ID matches expected value

Convenience method for validating chunk types during parsing.

§Example
use wow_adt::chunk_header::ChunkHeader;
use wow_adt::chunk_id::ChunkId;

let header = ChunkHeader {
    id: ChunkId::from_str("MVER").unwrap(),
    size: 4,
};

assert!(header.is_chunk(ChunkId::from_str("MVER").unwrap()));
assert!(!header.is_chunk(ChunkId::from_str("MHDR").unwrap()));

Trait Implementations§

Source§

impl BinRead for ChunkHeader

Source§

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options(). Read more
Source§

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments. Read more
Source§

fn read<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self: ReadEndian, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments. Read more
Source§

fn read_be<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order. Read more
Source§

fn read_le<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order. Read more
Source§

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>
where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order. Read more
Source§

fn read_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments. Read more
Source§

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments. Read more
Source§

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments. Read more
Source§

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>
where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments. Read more
Source§

impl BinWrite for ChunkHeader

Source§

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options(). Read more
Source§

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments. Read more
Source§

fn write<W>(&self, writer: &mut W) -> Result<(), Error>
where W: Write + Seek, Self: WriteEndian, Self::Args<'a>: for<'a> Required,

Write Self to the writer using default arguments. Read more
Source§

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>
where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order. Read more
Source§

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>
where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order. Read more
Source§

fn write_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>
where W: Write + Seek, Self: WriteEndian,

Write Self to the writer using the given arguments. Read more
Source§

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>
where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments. Read more
Source§

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>
where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments. Read more
Source§

impl Clone for ChunkHeader

Source§

fn clone(&self) -> ChunkHeader

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ChunkHeader

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl ReadEndian for ChunkHeader

Source§

const ENDIAN: EndianKind

The endianness of the type.
Source§

impl WriteEndian for ChunkHeader

Source§

const ENDIAN: EndianKind

The endianness of the type.
Source§

impl Copy for ChunkHeader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.