AFast

AFast is a high-performance asynchronous Rust backend framework designed to simplify building networked applications. It supports multiple protocols via feature flags and provides automatic code generation for clients (TypeScript and JavaScript), API documentation, and field validation.

Instrutions

Supported Protocol Features

You can enable the following features in your Cargo.toml:

• http - enable HTTP support
  • /api - HTTP API endpoint
  • /js - JavaScript client
  • /ts - TypeScript client
• ws - enable WebSocket support
  • /ws - WebSocket endpoint
• tcp - enable TCP support

Note on TCP usage:

If the tcp feature is enabled, the AFast::serve method takes two arguments:

1. The TCP address to listen on ("127.0.0.1:8080").
2. The HTTP/WS address ("127.0.0.1:8081") for web clients and generated JS/TS clients.

This allows you to run TCP and HTTP/WS servers simultaneously in the same application.

Key Features

• Automatic generation of TypeScript/JavaScript clients for your API
• Automatic generation of documentation
• Automatic field validation, including custom rules
• Async handler functions with state management
• Flexible multi-protocol support: HTTP, WS, TCP

Upcoming Features / Development Plan

• Nested structure validation for complex types
• Enable or disable js / ts / document by feautre flags
• Add command for generating client code
• Generate client code for additional languages: Java, Kotlin, C#, Rust, etc.
• Improved code generation templates for easier integration
• Enhanced error handling and validation reporting

Example

use std::sync::{Arc, Mutex};

use afast::{AFast, AFastData, Error, handler, register};

#[derive(Debug, Clone, AFastData)]
enum Sex {
    Male { id: i64 },
    Female { name: String },
}

#[derive(Debug, Clone, AFastData)]
struct Request {
    id: i64,
    name: String,
    #[validate(
        required("name is required"),
        min(1, "name must be at least 1 character long"),
        max(100, "name must be at most 10 characters long")
    )]
    age: u32,
    hobbies: Vec<Hobby>,
    tags: Vec<String>,
    gender: Option<bool>,
    sex: Sex,
}

#[derive(Debug, Clone, AFastData)]
struct Hobby {
    id: i64,
    name: String,
}

#[derive(Debug, AFastData)]
pub struct Response {
    sex: Sex,
    id: i64,
    name: String,
    age: u32,
    hobbies: Vec<Hobby>,
    tags: Vec<String>,
    gender: Option<bool>,
}

#[handler(desc("Get user information"))]
async fn get_user(
    _state: Arc<Mutex<String>>,
    header: Header,
    req: Request,
) -> Result<Response, Error> {
    Ok(Response {
        id: req.id,
        name: req.name.clone(),
        age: req.age,
        hobbies: req.hobbies.clone(),
        tags: req.tags.clone(),
        gender: req.gender,
        sex: req.sex.clone(),
    })
}

async fn auth(_state: Arc<Mutex<String>>, header: Header) -> Result<(), Error> {
    println!("Token: {:?}", header);
    Ok(())
}

#[derive(Debug, AFastData)]
struct Req2 {
    id: i64,
}

#[derive(Debug, AFastData)]
struct Resp2 {
    id: i64,
    name: String,
}

#[handler(desc("Get user by id"), mws("auth"))]
async fn get_id(_state: Arc<Mutex<String>>, header: Header, req: Req2) -> Result<Resp2, Error> {
    Ok(Resp2 {
        id: req.id,
        name: "John".to_string(),
    })
}

#[derive(Debug, Clone, AFastData)]
struct Header {
    id: u32,
}

#[tokio::main]
async fn main() {
    let state = Arc::new(Mutex::new("".to_string()));

    let server = AFast::<Mutex<String>, Header>::new(state, register! { get_user, get_id })
        .set_js(true) // Auto generate JS client
        .set_doc(true); // Auto generate documentation

    server
        .serve(&"127.0.0.1:8080", &"127.0.0.1:8081")
        .await
        .unwrap();
}