Enum StreamMagic 

#[non_exhaustive]
pub enum StreamMagic {
    V1,
}

Stream-header magic version dispatch — cross-version forward-compat dispatch surface. Each enum variant maps to a distinct 8-byte ASCII tag at the start of an exported stream; the reader dispatches on the recognised tag to select the corresponding frame-format parser.

V1 (the ARKHEXP1 baseline) is the only currently-reserved variant. Additional variants (V2 / V3 / …) may be added alongside this enum and the reader-side recognize lookup. The #[non_exhaustive] attribute makes the additive expansion non-breaking for external matchers.

Wire-stability invariant: the byte mapping for V1 is pinned at *b"ARKHEXP1" (golden hex vector 0x41 0x52 0x4B 0x48 0x45 0x58 0x50 0x31). Any change to the V1 byte pattern is a wire-format break and requires the same migration mechanism as a new variant.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

V1

ARKHEXP1 — wire baseline. Currently the only supported version.

Implementations

impl StreamMagic

pub const fn bytes(self) -> &'static [u8; 8]

Return the 8-byte tag for this version. const fn so callers can pin the byte pattern at compile time + use the result in const contexts.

pub fn recognize(bytes: &[u8; 8]) -> Option<Self>

Recognise a stream-header magic tag — Some(variant) when the 8-byte input matches a supported version, None for any unknown tag (caller surfaces via WalExportError::UnsupportedStreamVersion).

Fail-fast posture: this lookup runs against a stack 8-byte array — no heap allocation, no buffer slicing beyond the caller’s already-read header bytes.

Trait Implementations

impl Clone for StreamMagic

fn clone(&self) -> StreamMagic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamMagic

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

Formats the value using the given formatter.

impl PartialEq for StreamMagic

fn eq(&self, other: &StreamMagic) -> 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 StreamMagic

impl Eq for StreamMagic

impl StructuralPartialEq for StreamMagic