about summary refs log tree commit diff
path: root/custom_mutators/rust/README.md
diff options
context:
space:
mode:
authorjulihoh <julihoh@users.noreply.github.com>2021-02-27 15:05:13 +0100
committerGitHub <noreply@github.com>2021-02-27 15:05:13 +0100
commita5da9ce42cab1eab93cf80ca744944ae26e6ab58 (patch)
tree1292da64c63078318d789b2248c247d59173abf2 /custom_mutators/rust/README.md
parent79e02c2a9b2532624d7f187783ccbe9cbb04ce9b (diff)
downloadafl++-a5da9ce42cab1eab93cf80ca744944ae26e6ab58.tar.gz
custom mutator rust support (#752)
* custom mutator rust support

* clarify how to view documentation for rust mutators

* remove `FuzzResult` hack and clarify lifetimes of CustomMutator::fuzz

* rename TErr associated tyep to Error to be more idiomatic

* fix warnings

* add example for fallible custom mutator

* make Fallible Custom Mutator the default and implement it's handle_err method by default

* rename CustomMutator::handle_err to handle_error

* add example mutator using lain
Diffstat (limited to 'custom_mutators/rust/README.md')
-rw-r--r--custom_mutators/rust/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/custom_mutators/rust/README.md b/custom_mutators/rust/README.md
new file mode 100644
index 00000000..119ac790
--- /dev/null
+++ b/custom_mutators/rust/README.md
@@ -0,0 +1,9 @@
+Bindings to create custom mutators in Rust.
+
+These bindings are documented with rustdoc. To view the documentation run
+```cargo doc -p custom_mutator --open```.
+
+A minimal example can be found in `example`.
+
+An example using [lain](https://github.com/microsoft/lain) can be found in `example_lain`.
+Since lain requires a nightly rust toolchain, you need to set one up before you can play with it.