Struct Header 

pub struct Header {
    pub generation: Generation,
    pub tag: Tag,
    pub location: u32,
    pub aux: u32,
    pub version: u32,
}

The five fields both generations carry, verbatim.

No asserts live here: what location and aux mean is per format — a bank/slot pair on programs, a library location on samples, 0xFFFFFFFF where unset — so the container preserves them and the format modules interpret them.

Fields

generation: Generation

tag: Tag

location: u32

u32 at 0x0c. On slot-addressed formats the low u16 is the bank and the high u16 the slot; see Header::slot.

aux: u32

u32 at 0x10: unset, a program category in the low u16, or a format-specific two-word value. Preserved verbatim; see Header::category.

version: u32

u32 at 0x14: a format’s schema version (ne5p holds 4) or a library’s content version (nsmp holds format×100 + revision).

Implementations

impl Header

pub fn new(format: &str, location: (u16, u16), version: u32) -> Header

A fresh type-1 header — the generation every current device writes — with aux at the 0xFFFFFFFF the slot-addressed formats hold.

pub fn slot(&self) -> (u16, u16)

The location as the (bank, slot) pair slot-addressed formats store there.

pub fn category(&self) -> Option<u16>

The program category id most program formats keep in aux: the low u16 when the high u16 is zero, None for 0xFFFFFFFF (no category — the formats whose panel has no category picker) and for the both-halves shape the preset/library tags hold. What an id names is per model; the Stage 2/3 names are ProgramCategory.

pub fn set_slot(&mut self, (bank, slot): (u16, u16))

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Eq for Header

impl PartialEq for Header

fn eq(&self, other: &Header) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Header