Enum FeagiByteStructureType 

#[repr(u8)]
pub enum FeagiByteStructureType {
    JSON = 1,
    MultiStructHolder = 9,
    NeuronCategoricalXYZP = 11,
}

Enumeration of all supported FEAGI bytes structure format types.

Each variant corresponds to a specific serialization format and is used as the first bytes in the global header to identify the format type. The discriminant values are explicitly specified to ensure stability across different compiler versions and targets.

Format Identification

The type identifier is always stored as the first bytes in any FEAGI bytes structure, allowing immediate format detection without parsing the entire structure. This enables efficient routing to appropriate deserialization logic.

Stability Guarantee

The numeric values are explicitly assigned and must never change to maintain backward compatibility. New formats should use new unused numeric identifiers.

Usage in Headers

Byte 0: Format Type (this enum as u8)
Byte 1: Version number
Byte 2+: Format-specific data

Variants

JSON = 1

JSON serialization format (human-readable text)

MultiStructHolder = 9

Multi-structure container format.

A container format that can hold multiple different FEAGI structures in a single serialized bytes stream.

NeuronCategoricalXYZP = 11

Binary format for neuron categorical XYZP data.

Binary format specifically designed for neuron data with X, Y, Z coordinates and potential (P) values.

Implementations

impl FeagiByteStructureType

pub fn try_get_type_from_bytes( bytes: &[u8], ) -> Result<FeagiByteStructureType, FeagiDataError>

Extracts the format type from the first bytes of a bytes array.

This convenience method reads the type identifier directly from raw bytes data, performing the necessary validation and conversion. Commonly used during the initial parsing of incoming bytes structures.

Arguments

• bytes - Raw bytes array containing a FEAGI bytes structure

Returns

• Ok(FeagiByteStructureType) - Successfully identified format type
• Err(FeagiDataProcessingError) - If the bytes array is empty or contains an unknown type

Requirements

The bytes array must contain at least one byte. The first bytes is interpreted as the format type identifier according to the FEAGI bytes structure standard.

Trait Implementations

impl Debug for FeagiByteStructureType

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

Formats the value using the given formatter.

impl Display for FeagiByteStructureType

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

Formats the value using the given formatter.

impl PartialEq for FeagiByteStructureType

fn eq(&self, other: &FeagiByteStructureType) -> 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 TryFrom<u8> for FeagiByteStructureType

type Error = FeagiDataError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, FeagiDataError>

Performs the conversion.

impl StructuralPartialEq for FeagiByteStructureType