docs

libafl/src/bolts/bindings.rs

@@ -1,2 +1,4 @@
+//! Generated bindings
+
 #[cfg(all(windows, feature = "std"))]
 ::windows::include_bindings!();

libafl/src/bolts/os/mod.rs

@@ -1,3 +1,5 @@
+//! Operating System specific abstractions
+
 #[cfg(unix)]
 pub mod unix_signals;
 #[cfg(windows)]

libafl/src/bolts/os/unix_signals.rs

@@ -1,3 +1,4 @@
+//! Signal handling for unix
 use alloc::vec::Vec;
 use core::{
     cell::UnsafeCell,

libafl/src/bolts/os/windows_exceptions.rs

@@ -1,3 +1,5 @@
+//! Exception handling for Windows
+
 pub use crate::bolts::bindings::windows::win32::debug::EXCEPTION_POINTERS;
 
 use crate::{bolts::bindings::windows::win32::debug::SetUnhandledExceptionFilter, Error};

libafl/src/events/llmp.rs

@@ -1,3 +1,5 @@
+//! LLMP-backed event manager for scalable multi-processed fuzzing
+
 use alloc::{string::ToString, vec::Vec};
 use core::{marker::PhantomData, time::Duration};
 use serde::{de::DeserializeOwned, Serialize};

libafl/src/feedbacks/map.rs

@@ -1,3 +1,5 @@
+//! Map feedback, maximizing or minimizing maps, for example the afl-style map observer.
+
 use alloc::{
     string::{String, ToString},
     vec::Vec,

libafl/src/fuzzer.rs

@@ -1,3 +1,5 @@
+//! The `Fuzzer` is the main struct for a fuzz campaign.
+
 use crate::{
     corpus::CorpusScheduler,
     events::{Event, EventManager},

libafl/src/mutators/scheduled.rs

@@ -1,3 +1,5 @@
+//! The `ScheduledMutator` schedules multiple mutations internally.
+
 use alloc::string::String;
 use alloc::vec::Vec;
 use core::{

libafl/src/observers/map.rs

@@ -1,3 +1,5 @@
+//! The `MapObserver` provides access a map, usually injected into the target
+
 use alloc::{
     string::{String, ToString},
     vec::Vec,

libafl/src/observers/mod.rs

@@ -1,3 +1,5 @@
+//! Observers give insights about runs of a target, such as coverage, timing, stack depth, and more.
+
 pub mod map;
 pub use map::*;