about summary refs log tree commit diff
path: root/docs/custom_mutators.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 /docs/custom_mutators.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 'docs/custom_mutators.md')
-rw-r--r--docs/custom_mutators.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/custom_mutators.md b/docs/custom_mutators.md
index a2c544e3..61d711e4 100644
--- a/docs/custom_mutators.md
+++ b/docs/custom_mutators.md
@@ -4,6 +4,11 @@ This file describes how you can implement custom mutations to be used in AFL.
 For now, we support C/C++ library and Python module, collectivelly named as the
 custom mutator.
 
+There is also experimental support for Rust in `custom_mutators/rust`.
+Please refer to that directory for documentation.
+Run ```cargo doc -p custom_mutator --open``` in that directory to view the
+documentation in your web browser.
+
 Implemented by
 - C/C++ library (`*.so`): Khaled Yakdan from Code Intelligence (<yakdan@code-intelligence.de>)
 - Python module: Christian Holler from Mozilla (<choller@mozilla.com>)