Preview version, will not guarantee the stability of the API! Do NOT use in production environment!

Elegant, Clean Rust development framework🛸

TARDIS([tɑːrdɪs] "Time And Relative Dimension In Space") From "Doctor Who".

💖 Core functions

• Relational database client for MySQL, PostgresSQL
• Web service and web client for OpenAPI v3.x
• Distributed cache client for Redis protocol
• RabbitMQ client for AMQP protocol
• Search client for Elasticsearch
• Mail client for SMTP protocol
• Object Storage client for arbitrary S3 compatible APIs
• Mainstream encryption algorithms and SM2/3/4 algorithms
• Containerized unit testing of mainstream middleware
• Multi-environment configuration
• Multi-application aggregation
• Configure encryption support
• Internationalization and localization support
• Commonly used operations (E.g. uniform error handling, encryption and decryption, regular checksums)

⚙️Key Features

• conf-remote enable the unified configuration center
• crypto encryption, decryption and digest operations
• crypto-with-sm encryption, decryption and digest with SM.x operations
• future asynchronous operations
• reldb-core relational database core operations(based on SeaORM)
• reldb-postgres relational database with postgres driver
• reldb-mysql relational database with mysql driver
• reldb-sqlite relational database with sqlite driver
• reldb relational database with postgres/mysql/sqlite drivers
• web-server web service operations(based on Poem)
• web-client web client operations
• ws-client webscoket client operations
• cache cache operations
• mq message queue operations
• mail mail send operations
• os object Storage operations
• test unit test operations

🚀 Quick start

The core operations of the framework all use TardisFuns as an entry point. E.g.

TardisFuns::init(relative_path) // Initialize the configuration TardisFuns::field.x // Some field operations TardisFuns::reldb().x // Some relational database operations TardisFuns::web_server().x // Some web service operations

Web service example

Dependency Configuration toml [dependencies] tardis = { version = "^0", features = ["web-server"] }

Processor Configuration ```ignore use tardis::basic::error::TardisError; use tardis::web::poemopenapi; use tardis::web::poemopenapi::param::Query; use tardis::web::web_resp::{TardisApiResult, TardisResp};

pub struct Api;

[poem_openapi::OpenApi]

impl Api { #[oai(path = "/hello", method = "get")] async fn index(&self, name: Query>) -> TardisResult { match name.0 { Some(name) => TardisResp::ok(format!("hello, {name}!")), None => TardisResp::err(TardisError::NotFound("name does not exist".to_string())), } } } ```

Startup class configuration ```ignore use tardis::basic::result::TardisResult; use tardis::tokio; use tardis::TardisFuns; use crate::processor::Api; mod processor;

[tokio::main]

async fn main() -> TardisResult<()> { // Initial configuration TardisFuns::init("config").await?; // Register the processor and start the web service TardisFuns::webserver().addmodule("", Api).start().await } ```

More examples

|-- examples |-- reldb Relational database usage example |-- web-basic Web service Usage Example |-- web-client Web client Usage Example |-- websocket WebSocket Usage Example |-- cache Cache Usage Example |-- mq Message Queue Usage Example |-- todos A complete project usage example |-- multi-apps Multi-application aggregation example |-- pg-graph-search Graph search by Postgresql example |-- perf-test Performance test case

FAQ

• An failed to run custom build command for openssl-sys error occurs when running under Windows.The solution is as follows( @see https://github.com/sfackler/rust-openssl/issues/1062 ): shell git clone https://github.com/Microsoft/vcpkg --depth=1 cd vcpkg bootstrap-vcpkg.bat vcpkg.exe integrate install vcpkg.exe install openssl:x64-windows-static set OPENSSL_NO_VENDOR=1 set OPENSSL_DIR=<Current Dir>\packages\openssl_x64-windows-static

• An failed to run custom build command for openssl-sys error occurs when running under Ubuntu(similar to other distributions): shell apt install build-essential perl pkg-config libssl-dev

• FreeBSD deployment for openssl-sys shell sudo pkg install cmake ninja zip pkgconf gmake git clone https://github.com/Microsoft/vcpkg --depth=1 cd vcpkg sh bootstrap-vcpkg.sh ./vcpkg integrate install ./vcpkg install openssl

Thanks to Jetbrains for the Open Source License