Better docu (#90)

* more docs

* more docs:

* more docu

* more docu

* finished docs

* cleaned up markup

* must_use tags added

* more docs

* more docu, less clippy

* more fixes

Author: domenukk

.github/workflows/build_and_test.yml

@@ -57,7 +57,7 @@ jobs:
     - name: Build Docs
       run: cargo doc
     - name: Test Docs
-      run: cargo test --doc
+      run: cargo test --all-features --doc
     - name: Run clippy
       run: ./clippy.sh
   windows:

clippy.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 # Clippy checks
 cargo clean -p libafl
-RUST_BACKTRACE=full cargo clippy --all -- \
+RUST_BACKTRACE=full cargo clippy --all --all-features --tests -- \
    -D clippy::pedantic \
    -W clippy::cast_sign_loss \
    -W clippy::similar-names \
@@ -10,9 +10,9 @@ RUST_BACKTRACE=full cargo clippy --all -- \
    -W clippy::unused_self \
    -W clippy::too_many_lines \
    -W clippy::option_if_let_else \
-   -A missing-docs \
-   -A clippy::doc_markdown \
-   -A clippy::must-use-candidate \
+   -W clippy::must-use-candidate \
+   -W clippy::if-not-else \
+   -W clippy::doc-markdown \
    -A clippy::type_repetition_in_bounds \
    -A clippy::missing-errors-doc \
    -A clippy::cast-possible-truncation \
@@ -23,4 +23,3 @@ RUST_BACKTRACE=full cargo clippy --all -- \
    -A clippy::unseparated-literal-suffix \
    -A clippy::module-name-repetitions \
    -A clippy::unreadable-literal \
-   -A clippy::if-not-else \

fuzzers/frida_libpng/src/fuzzer.rs

@@ -276,7 +276,7 @@ unsafe fn fuzz(
             // Corpus that will be evolved, we keep it in memory for performance
             InMemoryCorpus::new(),
             // Feedbacks to rate the interestingness of an input
-            MaxMapFeedback::new_with_observer_track(&edges_observer, true, false),
+            MaxMapFeedback::new_tracking_with_observer(&edges_observer, true, false),
             // Corpus in which we store solutions (crashes in this example),
             // on disk so the user can get them after stopping the fuzzer
             OnDiskCorpus::new_save_meta(objective_dir, Some(OnDiskMetadataFormat::JsonPretty))

fuzzers/libfuzzer_libpng/src/lib.rs

@@ -80,7 +80,7 @@ fn fuzz(corpus_dirs: Vec<PathBuf>, objective_dir: PathBuf, broker_port: u16) ->
             InMemoryCorpus::new(),
             // Feedbacks to rate the interestingness of an input
             feedback_or!(
-                MaxMapFeedback::new_with_observer_track(&edges_observer, true, false),
+                MaxMapFeedback::new_tracking_with_observer(&edges_observer, true, false),
                 TimeFeedback::new_with_observer(&time_observer)
             ),
             // Corpus in which we store solutions (crashes in this example),

fuzzers/libfuzzer_reachability/src/lib.rs

@@ -79,7 +79,7 @@ fn fuzz(corpus_dirs: Vec<PathBuf>, objective_dir: PathBuf, broker_port: u16) ->
             // Corpus that will be evolved, we keep it in memory for performance
             InMemoryCorpus::new(),
             // Feedbacks to rate the interestingness of an input
-            MaxMapFeedback::new_with_observer_track(&edges_observer, true, false),
+            MaxMapFeedback::new_tracking_with_observer(&edges_observer, true, false),
             // Corpus in which we store solutions (crashes in this example),
             // on disk so the user can get them after stopping the fuzzer
             OnDiskCorpus::new(objective_dir).unwrap(),

fuzzers/libfuzzer_stb_image/src/main.rs

@@ -78,7 +78,7 @@ fn fuzz(corpus_dirs: Vec<PathBuf>, objective_dir: PathBuf, broker_port: u16) ->
             InMemoryCorpus::new(),
             // Feedbacks to rate the interestingness of an input
             feedback_or!(
-                MaxMapFeedback::new_with_observer_track(&edges_observer, true, false),
+                MaxMapFeedback::new_tracking_with_observer(&edges_observer, true, false),
                 TimeFeedback::new_with_observer(&time_observer)
             ),
             // Corpus in which we store solutions (crashes in this example),

libafl/src/bolts/compress.rs

@@ -17,6 +17,7 @@ pub struct GzipCompressor {
 impl GzipCompressor {
     /// If the buffer is at lest larger as large as the `threshold` value, we compress the buffer.
     /// When given a `threshold` of `0`, the `GzipCompressor` will always compress.
+    #[must_use]
     pub fn new(threshold: usize) -> Self {
         GzipCompressor { threshold }
     }