README.md

rocketmq-rust

Welcome to Apache Rocketmq Rust implementation. RocketMQ-Rust(Rust library) is a reimplementation of the Apache RocketMQ message middleware in the Rust language. This project aims to provide Rust developers with a high-performance and reliable message queue service, making full use of the features of the Rust language.

RocketMQ-Rust Features

• Rust Language Advantages: Leveraging the benefits of Rust, such as memory safety, zero-cost abstractions, and high concurrency performance, RocketMQ-Rust offers an efficient and reliable message middleware.
• Asynchronous and Non-blocking Design: RocketMQ-Rust takes full advantage of Rust's asynchronous programming capabilities, adopting a non-blocking design that supports high-concurrency message processing.
• Ecosystem Integration: As part of the Rust ecosystem, RocketMQ-Rust integrates well with other libraries and frameworks within the Rust ecosystem, providing flexible integration options for developers.
• Cross-platform Support: RocketMQ-Rust supports multiple platforms, including Linux, Windows, macOS, making it convenient for use in different environments.

Roadmap

🔊Note: Rocketmq-rust is implemented based on Apache Rocketmq release-5.3.1📌, with subsequent feature enhancements to follow the updates of the version🚩.

🔊Release a new version every three months to fix issues. If there are major updates or new features, additional releases will be scheduled🍻.

🔖Version	🚩Release time	🚧Remark
🔖v0.1.0	🚩2024-01-28	Released🎉
🔖v0.2.0	🚩2024-06-05	Released🎉
🔖v0.3.0	🚩2024-11-17	Released🎉
🔖v0.4.0	🚩2025-02-17	🚧
🔖v0.5.0	🚩2025-05-17	🚧
🔖v0.6.0	🚩2025-08-17	🚧
🔖v0.7.0	🚩2025-11-17	🚧
🔖v0.8.0	🚩2026-02-17	🚧
🔖v0.9.0	🚩2026-05-17	🚧
🔖....	🚩....	🚧...

Getting Started

Requirements

1. rust toolchain MSRV is 1.75.(stable,nightly)

Run name server

Run the following command to see usage：

• windows platform

  cargo run --bin rocketmq-namesrv-rust -- --help
  
  RocketMQ Name server(Rust)
  
  Usage: rocketmq-namesrv-rust.exe [OPTIONS]
  
  Options:
    -p, --port <PORT>  rocketmq name server port [default: 9876]
    -i, --ip <IP>      rocketmq name server ip [default: 127.0.0.1]
    -h, --help         Print help
    -V, --version      Print version

• Linux platform

  $ cargo run --bin rocketmq-namesrv-rust -- --help
  
  RocketMQ Name server(Rust)
  
  Usage: rocketmq-namesrv-rust [OPTIONS]
  
  Options:
    -p, --port <PORT>  rocketmq name server port [default: 9876]
    -i, --ip <IP>      rocketmq name server ip [default: 127.0.0.1]
    -h, --help         Print help
    -V, --version      Print version

Run the following command to start the name server

cargo run --bin rocketmq-namesrv-rust

Run Borker

Run the following command to see usage：

• windows platform

  cargo run --bin rocketmq-broker-rust -- --help
  
  RocketMQ Broker Server(Rust)
  
  Usage: rocketmq-broker-rust.exe [OPTIONS]
  
  Options:
    -c, --config-file <FILE>      Broker config properties file
    -m, --print-important-config  Print important config item
    -n, --namesrv-addr <IP>       Name server address list, eg: '192.168.0.1:9876;192.168.0.2:9876' [default: 127.0.0.1:9876]
    -p, --print-config-item       Print all config item
    -h, --help                    Print help
    -V, --version                 Print version

• Linux platform

  $ cargo run --bin rocketmq-broker-rust -- --help
  
  RocketMQ Broker Server(Rust)
  
  Usage: rocketmq-broker-rust [OPTIONS]
  
  Options:
    -c, --config-file <FILE>      Broker config properties file
    -m, --print-important-config  Print important config item
    -n, --namesrv-addr <IP>       Name server address list, eg: '192.168.0.1:9876;192.168.0.2:9876' [default: 127.0.0.1:9876]
    -p, --print-config-item       Print all config item
    -h, --help                    Print help
    -V, --version                 Print version

Run the following command to start the name server

cargo run --bin rocketmq-broker-rust

Client how to send message

First, start the RocketMQ NameServer and Broker services.

• Send a single message

• Send batch messages

• Send RPC messages

For more examples, you can check here

Modules

The existing RocketMQ has the following functional modules:

• Name Server
• Broker
• Store (Local Storage)
• Controller (High Availability)
• Client (SDK)
• Proxy
• Tiered Store (Tiered Storage Module)

The specific functions of each module can be referred to in the official RocketMQ documentation. The Rust implementation will be carried out sequentially in the following order.

Contributing

Contributions to code, issue reporting, and suggestions are welcome. The development of RocketMQ-Rust relies on the support of developers. Let's collaborate to advance Rust in the message middleware domain.

License

RocketMQ-Rust is licensed under the Apache License 2.0 and MIT license