ndelvalle / rustdis

Partial Redis server implementation using Rust for learning purposes.

rustdis

Welcome to rustdis, a partial Redis server implementation written in Rust.

This project came to life out of pure curiosity, and because we wanted to learn more about Rust and Redis. So doing this project seemed like a good idea. The primary goal of rustdis is to offer a straightforward and comprehensible implementation, with no optimization techniques to ensure the code remains accessible and easy to understand. As of now, rustdis focuses exclusively on implementing Redis' String data type and its associated methods. You can find more about Redis strings here: Redis Strings.

This server is not production-ready; it is intended purely for educational purposes.

Run

cargo run

Test

cargo test

rustdis's Issues

String commands

All string commands (without options)

• APPEND
• DECR #32
• DECRBY #32
• GET
• GETDEL
• GETRANGE
• INCR #32
• INCRBY #32
• INCRBYFLOAT #35
• LCS #31
• MGET #34
• MSET #34
• MSETNX #34
• SET
• SETNX
• SETRANGE #33
• STRLEN
• GETEX ~ requires TTL
• SETEX deprecated
• GETSET deprecated
• SUBSTR deprecated
• PSETEX deprecated

POC Milestone

Commands

• GET
• SET
• DEL
• EXISTS
• KEYS

Resources used to learn and write this implementation

This will eventually be on the readme or some nicer place.
Resources:

• https://tokio.rs/tokio/tutorial
• https://redis.io/docs/reference/protocol-spec/
• https://docs.rs/tokio-util/latest/tokio_util/codec/index.html

Milestones

Milestones

1. Make it public (2024-04-23) ✅
2. Support string commands (without options) /commands/?group=string & /data-types/strings/ (2024-05-05) ✅
   • https://github.com/ndelvalle/rustdis/milestone/1
   • #30
3. Document it (README, notes, comments, et al)
   • https://github.com/ndelvalle/rustdis/milestone/2
4. Server improvements (TTL, client info, etc)
   • https://github.com/ndelvalle/rustdis/milestone/3
5. Future milestones
   1. Persist to disk & "log file" (Redis persistence)
   2. Compatibility test suit
   3. String commands with all options

TO-DO

• Does the protocol ever send -1 on the bulk error?
• Change the store type to keep information about the key (eg. ttl) @gillchristian
• Keep a record of connected clients. For client commands. @gillchristian
• TTL
• Validate argument count:

  redis> PING hello world
  (error) wrong number of arguments for 'ping' command
  

• All string commands /commands/?group=string & /data-types/strings/
• Bulk frames (string / error) could be optimized by reading the specified length
• Documentation and notes (ferrum-field.vercel.app)
• Implement logging
• Nested commands (eg.object encoding, object freq)