From ace2da1f3e6c99862f2cef41dd822bbf3eb5019a Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Wed, 20 Mar 2019 12:18:25 +0200 Subject: [PATCH] Add a note about no-panic behavior of this crate --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 83578ec..324ff82 100644 --- a/README.md +++ b/README.md @@ -219,6 +219,16 @@ See [LICENSE](LICENSE) for details. +## No Panicking + +This makes extensive use of the `Result` pattern and is intended to never panic. +But unfortunately, Rust does not provide any features to prove this behavior. +The developer of this crate has not found a good solution to ensure no-panic behavior in any way. +Please report a panic immediately if you found it as issue on [github](https://github.com/ISibboI/evalexpr/issues). + +Even if the crate itself is panic free, it allows the user to define custom functions that are executed by the crate. +The user needs to ensure that the function he provides to the crate never panic. + ## Closing Notes If you have any ideas for features or see any problems in the code, architecture, interface, algorithmics or documentation, please open an issue on github.