From a953e3936057fbd9823d1f86c90970af16e06530 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20M=C3=BCller?= Date: Sat, 20 Feb 2021 07:41:03 +0000 Subject: [PATCH] Update README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index eaeb6c3..c33b852 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,15 @@ arbitrary data to it. In Ruby there is [Daybreak] however for Rust there was no similar crate, until now! +When not to use it +------------------ + +Rustbreak makes several trade-offs to be easy to use and extend, so knowing of these drawbacks is important if +you wish to use the library: + +- The Database needs to fit into memory (Rustbreak cannot do partial loads/saves, so if the Database exceeds your available memory you will run OOM) +- Not all backends support atomic saves, so if your program crashes while it is saving you might save incomplete data (Notably only `PathBackend` supports atomic saves) + Features --------