Struct ParaglobHeader 

#[repr(C)]
pub struct ParaglobHeader {

    pub magic: [u8; 8],
    pub version: u32,
    pub match_mode: u32,
    pub ac_node_count: u32,
    pub ac_nodes_offset: u32,
    pub ac_edges_size: u32,
    pub ac_patterns_size: u32,
    pub pattern_count: u32,
    pub patterns_offset: u32,
    pub pattern_strings_offset: u32,
    pub pattern_strings_size: u32,
    pub meta_word_mapping_count: u32,
    pub meta_word_mappings_offset: u32,
    pub pattern_refs_size: u32,
    pub wildcard_count: u32,
    pub total_buffer_size: u32,
    pub endianness: u8,
    pub reserved: [u8; 3],
    pub data_section_offset: u32,
    pub data_section_size: u32,
    pub mapping_table_offset: u32,
    pub mapping_count: u32,
    pub data_flags: u32,
    pub reserved_v2: u32,
    pub ac_literal_map_offset: u32,
    pub ac_literal_map_count: u32,
    pub glob_segments_offset: u32,
    pub glob_segments_size: u32,
}

Main header for serialized Paraglob database (112 bytes, 4-byte aligned)

This header appears at the start of every serialized Paraglob file. All offsets are relative to the start of the buffer.

Version History

• v1 (72 bytes): Original format, patterns only
• v2 (96 bytes): Adds data section support for pattern-associated data
• v3 (104 bytes): Adds AC literal mapping for O(1) zero-copy loading
• v4 (104 bytes): Uses ACNodeHot (20-byte) instead of ACNode (32-byte) - BREAKING
• v5 (112 bytes): Adds serialized glob segments for zero-copy loading

Fields

magic: [u8; 8]

Magic bytes: “PARAGLOB”

version: u32

Format version (currently 5)

match_mode: u32

Match mode: 0=CaseSensitive, 1=CaseInsensitive

ac_node_count: u32

Number of nodes in the AC trie

ac_nodes_offset: u32

Offset to first AC node

ac_edges_size: u32

Total size of AC edges data

ac_patterns_size: u32

Total size of AC pattern ID arrays

pattern_count: u32

Total number of original glob patterns

patterns_offset: u32

Offset to pattern entry array

pattern_strings_offset: u32

Offset to pattern strings area

pattern_strings_size: u32

Total size of pattern strings

meta_word_mapping_count: u32

Number of meta-word to pattern mappings

meta_word_mappings_offset: u32

Offset to meta-word mapping array

pattern_refs_size: u32

Total size of pattern reference arrays

wildcard_count: u32

Number of pure wildcard patterns (no literals)

total_buffer_size: u32

Total size of the entire serialized buffer (bytes)

endianness: u8

Endianness marker: 0x01=little-endian, 0x02=big-endian, 0x00=legacy (assume little-endian) Database is always stored in little-endian format. This field indicates the endianness of the system that created the file. On big-endian systems, all multi-byte values are byte-swapped on read.

reserved: [u8; 3]

Reserved for future use

data_section_offset: u32

Offset to data section (0 = no data section) Points to MMDB-encoded data or other serialized data

data_section_size: u32

Size of data section in bytes (0 = no data)

mapping_table_offset: u32

Offset to pattern→data mapping table (0 = no mappings) Each mapping is a PatternDataMapping struct

mapping_count: u32

Number of pattern→data mappings Should equal pattern_count if all patterns have data

data_flags: u32

Data type flags:

• Bit 0: inline data (1) vs external references (0)
• Bit 1-31: reserved

reserved_v2: u32

Reserved for future v2+ features

ac_literal_map_offset: u32

Offset to AC literal→pattern mapping table (0 = no mapping, requires reconstruction) Points to serialized HashMap<u32, Vec<u32>> for instant loading Format: [entry_count: u32] followed by entries of: [literal_id: u32][pattern_count: u32][pattern_id: u32, ...]

ac_literal_map_count: u32

Number of entries in AC literal mapping table 0 = v1/v2 file, requires reconstruct_literal_mapping()

glob_segments_offset: u32

Offset to glob segment index (0 = no segments, use lazy parsing) Points to array of GlobSegmentIndex structs (one per pattern)

glob_segments_size: u32

Total size of glob segment data (index + segment structures + string data)

Implementations

impl ParaglobHeader

pub fn new() -> ParaglobHeader

Create a new v3 header with magic and version

pub fn validate(&self) -> Result<(), &'static str>

Validate header magic and version

pub fn validate_offsets(&self, buffer_len: usize) -> Result<(), &'static str>

Validate that all header offsets are within buffer bounds

pub fn has_data_section(&self) -> bool

Check if this file has a data section

pub fn has_ac_literal_mapping(&self) -> bool

Check if this file has a pre-built AC literal mapping (v3+)

pub fn has_inline_data(&self) -> bool

Check if data is inline (true) or external references (false)

pub fn has_glob_segments(&self) -> bool

Check if this file has pre-built glob segments (v5+)

Trait Implementations

impl Clone for ParaglobHeader

fn clone(&self) -> ParaglobHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParaglobHeader

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

Formats the value using the given formatter.

impl Default for ParaglobHeader

fn default() -> ParaglobHeader

Returns the “default value” for a type.

impl FromBytes for ParaglobHeader

where [u8; 8]: FromBytes, u32: FromBytes, u8: FromBytes, [u8; 3]: FromBytes,

fn ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the given source as a &Self.

fn ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout + Immutable,

Interprets the prefix of the given source as a &Self without copying.

fn ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: Immutable + KnownLayout,

Interprets the suffix of the given bytes as a &Self.

fn mut_from_bytes( source: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the given source as a &mut Self.

fn mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the prefix of the given source as a &mut Self without copying.

fn mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout,

Interprets the suffix of the given source as a &mut Self without copying.

fn ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &Self with a DST length equal to count.

fn ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the prefix of the given source as a DST &Self with length equal to count.

fn ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, Infallible>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the suffix of the given source as a DST &Self with length equal to count.

fn mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize> + Immutable,

Interprets the given source as a &mut Self with a DST length equal to count.

fn mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the prefix of the given source as a &mut Self with DST length equal to count.

fn mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, Infallible>>

where Self: IntoBytes + KnownLayout<PointerMetadata = usize>,

Interprets the suffix of the given source as a &mut Self with DST length equal to count.

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for ParaglobHeader

where [u8; 8]: FromZeros, u32: FromZeros, u8: FromZeros, [u8; 3]: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl IntoBytes for ParaglobHeader

where [u8; 8]: IntoBytes, u32: IntoBytes, u8: IntoBytes, [u8; 3]: IntoBytes, (): PaddingFree<ParaglobHeader, matchy_paraglob::::offset_format::{impl#14}::{constant#2}>,

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

where Self: Immutable,

Gets the bytes of this value.

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

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl KnownLayout for ParaglobHeader

where u32: KnownLayout,

type PointerMetadata = <u32 as KnownLayout>::PointerMetadata

The type of metadata stored in a pointer to Self.

fn size_for_metadata(meta: Self::PointerMetadata) -> Option<usize>

Computes the size of an object of type Self with the given pointer metadata.

impl TryFromBytes for ParaglobHeader

where [u8; 8]: TryFromBytes, u32: TryFromBytes, u8: TryFromBytes, [u8; 3]: TryFromBytes,

fn try_ref_from_bytes( source: &[u8], ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the given source as a &Self.

fn try_ref_from_prefix( source: &[u8], ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the prefix of the given source as a &Self.

fn try_ref_from_suffix( source: &[u8], ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout + Immutable,

Attempts to interpret the suffix of the given source as a &Self.

fn try_mut_from_bytes( bytes: &mut [u8], ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the given source as a &mut Self without copying.

fn try_mut_from_prefix( source: &mut [u8], ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self.

fn try_mut_from_suffix( source: &mut [u8], ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self.

fn try_ref_from_bytes_with_elems( source: &[u8], count: usize, ) -> Result<&Self, ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the given source as a &Self with a DST length equal to count.

fn try_ref_from_prefix_with_elems( source: &[u8], count: usize, ) -> Result<(&Self, &[u8]), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the prefix of the given source as a &Self with a DST length equal to count.

fn try_ref_from_suffix_with_elems( source: &[u8], count: usize, ) -> Result<(&[u8], &Self), ConvertError<AlignmentError<&[u8], Self>, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + Immutable,

Attempts to interpret the suffix of the given source as a &Self with a DST length equal to count.

fn try_mut_from_bytes_with_elems( source: &mut [u8], count: usize, ) -> Result<&mut Self, ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_prefix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut Self, &mut [u8]), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the prefix of the given source as a &mut Self with a DST length equal to count.

fn try_mut_from_suffix_with_elems( source: &mut [u8], count: usize, ) -> Result<(&mut [u8], &mut Self), ConvertError<AlignmentError<&mut [u8], Self>, SizeError<&mut [u8], Self>, ValidityError<&mut [u8], Self>>>

where Self: KnownLayout<PointerMetadata = usize> + IntoBytes,

Attempts to interpret the suffix of the given source as a &mut Self with a DST length equal to count.

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl Copy for ParaglobHeader

impl Immutable for ParaglobHeader

where [u8; 8]: Immutable, u32: Immutable, u8: Immutable, [u8; 3]: Immutable,