hyperion-framework

Crates.iohyperion-framework
lib.rshyperion-framework
version0.4.0
created_at2025-07-16 05:24:39.809407+00
updated_at2025-08-17 17:54:53.516887+00
descriptionA lightweight component-based TCP framework for building service-oriented Rust applications with CLI control, async messaging, and lifecycle management.
homepagehttps://github.com/robert-hannah/hyperion-framework
repositoryhttps://github.com/robert-hannah/hyperion-framework
max_upload_size
id1754942
size261,311
Robert Hannah (robert-hannah)

documentation

https://github.com/robert-hannah/hyperion-framework-examples

README

hyperion-framework

A lightweight component-based TCP framework for building service-oriented Rust applications with CLI control, async messaging, and lifecycle management.

Quickfire Features

  • 🔌 Component-Based Architecture: Build modular systems with loosely coupled components
  • 🌐 TCP Communication: Built-in networking support for distributed systems
  • ⚙️ Configuration Handling: Built in unique config and network topology handling for each component
  • 💻 CLI Integration: Command-line interface for system control and monitoring
  • 🔄 State Management: Robust component state handling and lifecycle management
  • 📦 Containerisation: Simplified component containment and management
  • 🚀 Async Support: Built on tokio for high-performance async operations

Hyperion Overview

Hyperion is designed around a component-based architecture, allowing you to create modular services that communicate over TCP. Each component is encapsulated in a HyperionContainer, which manages its lifecycle, configuration, and state.

Each component becomes a self-contained, event-driven service that:

Listens and responds to structured TCP messages

Exposes a CLI for control and inspection

Handles its own config parsing, logging, and lifecycle state (start/restart/shutdown)

Hyperion is ideal for service-oriented projects where you want clean separation of logic, real-time communication, and container-like encapsulation within native Rust programs.

The framework makes it simple to bring your project into a fully asynchronous and multithreaded service-based environment, enabling independent component development, easier debugging, and scalability.

Hyperion is also built on top of the Tokio async runtime, enabling high-performance, non-blocking operations.

Architecture Overview

Alt text

Installation via crates.io

Add this to your Cargo.toml:

hyperion-network = 0.4.0

Example Implementation

Documentation

Project Structure

  • network/: TCP communication and networking components
  • messages/: Message definitions and component directives
  • utilities/: Common utilities and helper functions
  • data_management/: Data handling and persistence
  • containerisation/: Component lifecycle and state management

Dependencies

  • async-trait (0.1.88) - Async trait support
  • colored (3.0.0) - Terminal coloring
  • log (0.4.27) - Logging infrastructure
  • serde (1.0.219) - Serialisation
  • serde_json (1.0.142) - JSON support
  • serde-xml-rs (0.8.1) - XML support
  • tokio (1.47.1) - Async runtime

Contributing

Contributions are welcome! Please feel free to submit a PR with a comprehensive description of work done.

Current TODOs (feel free to contact for more details)

  • Container heartbeats/master container state request mechanic
  • Manually retry connections if the connection retry cap is reached
  • Improved container startup boilerplate
  • Generally improve unit and integration test coverage
  • Component restart on failure (automatic and ClI induced)

License

Apache 2.0

Test Pipeline

hyperion-framework CI

Commit count: 0

cargo fmt