Struct Header

#[repr(C, align(8))]
pub struct Header {
    pub magic: [u8; 4],
    pub version: u8,
    pub num_sorts: u8,
    pub reserved: [u8; 2],
    pub num_terms: U32<LE>,
    pub num_thms: U32<LE>,
    pub p_terms: U32<LE>,
    pub p_thms: U32<LE>,
    pub p_proof: U32<LE>,
    pub reserved2: [u8; 4],
    pub p_index: U64<LE>,
}

The header of an MMB file, which is always in the first bytes of the file. It is followed by a sorts: [SortData; num_sorts] array (which we keep separate because of the dependency).

Fields

magic: [u8; 4]

The magic number, which is used to identify this as an mmb file. Must be equal to MM0B_MAGIC = "MM0B".

version: u8

The MMB format version number. Must equal MM0B_VERSION = 1.

num_sorts: u8

The number of sorts in the file. This is limited to 128.

reserved: [u8; 2]

Padding.

num_terms: U32<LE>

The number of terms and defs in the file.

num_thms: U32<LE>

The number of axioms and theorems in the file.

p_terms: U32<LE>

The pointer to the term table of type [TermEntry; num_terms].

p_thms: U32<LE>

The pointer to the theorem table of type [ThmEntry; num_thms].

p_proof: U32<LE>

The pointer to the declaration stream.

reserved2: [u8; 4]

Padding.

p_index: U64<LE>

The pointer to the index header, an array of id, data fields that are parsed by MmbIndexBuilder::build.

Implementations

impl Header

pub fn check(&self, mmb: &[u8]) -> Result<(), ParseError>

On top of the magic number and version checks, perform a non-exhaustive list of miscellaneous checks to see whether there are issues with the header that won’t be caught by the type system or the integer parsers.

For example, none of the pointers in the header should be greater than the length of the file, the terms pointer should be less than the theorems pointer, etc.

Trait Implementations

impl AsBytes for Header

fn as_bytes(&self) -> &[u8]

Gets the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

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 Default for Header

fn default() -> Header

Returns the “default value” for a type.

impl FromBytes for Header

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl Copy for Header