🍵 HTeaPot

A blazing-fast, minimalist HTTP server library built with Rust

English | Español

A high-performance, lightweight HTTP server and library built in Rust. HTeaPot is designed to deliver exceptional performance for modern web applications while maintaining a simple and intuitive API.

📚 Table of Contents

• Features
• Getting Started
  • Standalone Server
  • As a Library
• Performance
• Roadmap
• Contributing
• License
• Acknowledgments

✨ Features

Exceptional Performance

• Threaded Architecture: Powered by a custom-designed thread system that handles 70,000+ requests per second
• Consistent Under Load: Maintains steady performance even under high concurrency scenarios
• Resilient: Achieves near-perfect 100% success rate for 200 OK responses during stress tests

Versatile Functionality

• Static File Serving: Efficiently serve static assets with minimal configuration
• Streaming Support: Leverages chunked transfer encoding for large files and long-lived connections
• Flexible API: Use HTeaPot as a standalone server or as a library in your Rust applications

Developer-Friendly

• Simple Configuration: Get started quickly with intuitive TOML configuration
• Extensible Design: Easily customize behavior for specific use cases
• Lightweight Footprint: Zero dependencies and efficient resource usage

🚀 Getting Started

🔧 Installation

# Install from crates.io
cargo install hteapot

# Or build from source
git clone https://github.com/Az107/hteapot.git
cd hteapot
cargo build --release

🖥️ Running the Server

Option 1: With Config

1. Create a config.toml file:

[HTEAPOT]
port = 8081        # The port to listen on
host = "localhost" # The host address to bind to
root = "public"    # The root directory to serve files from

2. Run the server:

hteapot ./config.toml

Option 2: Quick Serve

hteapot -s ./public/

🦀 Using as a Library

1. Add HTeaPot to your Cargo.toml project:

cargo add hteapot

2. Implement in your code: example

use hteapot::{HttpStatus, HttpResponse, Hteapot, HttpRequest};

fn main() {
    // Create a new server instance
    let server = Hteapot::new("localhost", 8081);
    
    // Define your request handler
    server.listen(move |req: HttpRequest| {
        HttpResponse::new(HttpStatus::IAmATeapot, "Hello, I am HTeaPot", None)
    });
}

📊 Performance

HTeaPot has been benchmarked against other popular HTTP servers, consistently demonstrating excellent metrics:

Roadmap

• HTTP/1.1 support (keep-alive, chunked encoding)
• Library API
• Streaming responses
• Multipart form handling
• Basic routing system
• HTTPS support
• Compression (gzip/deflate)
• WebSocket support
• Enhanced documentation and examples

Contributing

We welcome contributions from the community! To get started:

# Format the code
cargo fmt

# Lint for warnings
cargo clippy --all-targets --all-features

# Run tests
cargo test

See CONTRIBUTING.md for more details.

License

HTeaPot is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• The Rust community for their exceptional tools and libraries
• Our contributors who have helped shape this project
• Users who provide valuable feedback and bug reports