Struct Header 

pub struct Header {

    pub magic: [u8; 4],
    pub version: u32,
    pub checksum: u32,
    pub total_size: u32,
    pub str_blob_offset: u32,
    pub str_table_offset: u32,
    pub node_types_offset: u32,
    pub node_fields_offset: u32,
    pub trivia_offset: u32,
    pub type_meta_offset: u32,
    pub entrypoints_offset: u32,
    pub transitions_offset: u32,
    pub str_table_count: u16,
    pub node_types_count: u16,
    pub node_fields_count: u16,
    pub trivia_count: u16,
    pub entrypoints_count: u16,
    pub transitions_count: u16,
    pub flags: u16,
    /* private fields */
}

File header - first 64 bytes of the bytecode file.

Note: TypeMeta sub-section counts are stored in the TypeMetaHeader, not in the main header. See type_meta.rs for details.

Fields

magic: [u8; 4]

Magic bytes: b“PTKQ“

version: u32

Format version (currently 1)

checksum: u32

CRC32 checksum of everything after the header

total_size: u32

Total file size in bytes

str_blob_offset: u32

str_table_offset: u32

node_types_offset: u32

node_fields_offset: u32

trivia_offset: u32

type_meta_offset: u32

entrypoints_offset: u32

transitions_offset: u32

str_table_count: u16

node_types_count: u16

node_fields_count: u16

trivia_count: u16

entrypoints_count: u16

transitions_count: u16

flags: u16

Header flags (see flags module for bit definitions).

Implementations

impl Header

pub fn from_bytes(bytes: &[u8]) -> Self

Decode header from 64 bytes.

pub fn to_bytes(&self) -> [u8; 64]

Encode header to 64 bytes.

pub fn validate_magic(&self) -> bool

pub fn validate_version(&self) -> bool

pub fn is_linked(&self) -> bool

Returns true if the bytecode is linked (contains resolved grammar IDs).

pub fn set_linked(&mut self, linked: bool)

Set the linked flag.

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

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Header

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Header

impl Eq for Header

impl StructuralPartialEq for Header