# abitofevrything/binary_serializable architecture

> Architecture diagram of the GitHub repository abitofevrything/binary_serializable, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/abitofevrything/binary_serializable
- Repository: https://github.com/abitofevrything/binary_serializable

## Overview

##### Main Components

a) Core Library Components:
- Binary Serializable Core Module
- Built-in Type Handlers
- Code Generator
- Composite Conversion Handler
- Multi Binary Type Handler

b) Data Flow Components:
- Input Objects
- Serialization Pipeline
- Binary Output
- Deserialization Pipeline

**┌─────────────────────┐**
- Client Code      │
- ┘

**┌─────────────────────┐    ┌─────────────────────┐**
- Code Generator     │───▶│ Generated Handlers  │
- ┘    └─────────────────────┘

- ▼
**┌─────────────────────┐**
- Binary Conversion  │
- Pipeline        │
- ┘

**┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐**
- Built-in │ │  Array   │ │  String  │ │  Buffer  │
- Types   │ │ Handlers │ │ Handlers │ │ Handlers │
- ┘ └──────────┘ └──────────┘ └──────────┘

##### Important Elements to Highlight

a) Core Processing:
- Binary_serializable.dart as the main entry point
- Relationship between binary_conversion.dart and binary_type.dart
- Composite_binary_conversion.dart handling complex types

b) Type System:
- Built-in type handlers (bool, int, float, string, buffer, array)
- How multi_binary_type.dart interfaces with different type handlers

c) Code Generation:
- Flow from @BinarySerializable annotations to generated code
- How the generator interfaces with the core library

##### Specific Implementation Notes

- The separation between binary_serializable and binary_serializable_generator packages
- The relationship between built-in types and custom serialization
- The benchmark system's role in performance validation
- The test harness architecture

## Diagram (Mermaid)

```mermaid
graph TB
    %% Main Components
    Client[Client Code]:::external
    
    subgraph Core["Core Processing Layer"]
        BinarySerializable["Binary Serializable Core"]:::core
        BinaryConversion["Binary Conversion"]:::core
        BinaryType["Binary Type"]:::core
        CompositeBinaryConversion["Composite Conversion Handler"]:::core
        MultiBinaryType["Multi Binary Type Handler"]:::core
    end
    
    subgraph Generator["Code Generation Layer"]
        CodeGenerator["Code Generator"]:::generator
        GeneratedHandlers["Generated Handlers"]:::generated
    end
    
    subgraph TypeHandlers["Type Handlers Layer"]
        subgraph BuiltIn["Built-in Types"]
            BoolHandler["Boolean Handler"]:::handler
            IntHandler["Integer Handler"]:::handler
            FloatHandler["Float Handler"]:::handler
            StringHandler["String Handler"]:::handler
            BufferHandler["Buffer Handler"]:::handler
            ArrayHandler["Array Handler"]:::handler
        end
    end
    
    subgraph Testing["Testing & Benchmarking"]
        Benchmark["Benchmark System"]:::test
        TestHarness["Test Harness"]:::test
        BuiltInTests["Built-in Type Tests"]:::test
        CompositeTests["Composite Tests"]:::test
    end
    
    %% Relationships
    Client --> BinarySerializable
    BinarySerializable --> BinaryConversion
    BinaryConversion --> BinaryType
    BinaryType --> MultiBinaryType
    MultiBinaryType --> CompositeBinaryConversion
    
    CodeGenerator --> GeneratedHandlers
    GeneratedHandlers --> BinarySerializable
    
    CompositeBinaryConversion --> BuiltIn
    MultiBinaryType --> BuiltIn
    
    Benchmark --> BinarySerializable
    TestHarness --> BinarySerializable
    BuiltInTests --> BuiltIn
    CompositeTests --> CompositeBinaryConversion
    
    %% Click Events
    click BinarySerializable "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/binary_serializable.dart"
    click BinaryConversion "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/binary_conversion.dart"
    click BinaryType "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/binary_type.dart"
    click CompositeBinaryConversion "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/composite_binary_conversion.dart"
    click MultiBinaryType "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/multi_binary_type.dart"
    click CodeGenerator "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable_generator/lib/src/binary_serializable_generator.dart"
    click BoolHandler "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/built_in/bool.dart"
    click IntHandler "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/built_in/int.dart"
    click FloatHandler "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/built_in/float.dart"
    click StringHandler "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/built_in/string.dart"
    click BufferHandler "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/built_in/buffer.dart"
    click ArrayHandler "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/lib/src/built_in/array.dart"
    click Benchmark "https://github.com/abitofevrything/binary_serializable/tree/main/packages/binary_serializable/benchmark"
    click TestHarness "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/test/harness.dart"
    click BuiltInTests "https://github.com/abitofevrything/binary_serializable/tree/main/packages/binary_serializable/test/built_in"
    click CompositeTests "https://github.com/abitofevrything/binary_serializable/blob/main/packages/binary_serializable/test/composite_binary_conversion_test.dart"
    
    %% Styles
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef generator fill:#4CAF50,stroke:#388E3C,color:white
    classDef generated fill:#81C784,stroke:#4CAF50,color:white
    classDef handler fill:#FF9800,stroke:#F57C00,color:white
    classDef test fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef external fill:#757575,stroke:#616161,color:white
```
