Struct libafl::corpus::ondisk::OnDiskCorpus
source · pub struct OnDiskCorpus<I>where
I: Input,{ /* private fields */ }
Expand description
A corpus able to store Testcase
s to disk, and load them from disk, when they are being used.
Metadata is written to a .<filename>.metadata
file in the same folder by default.
Implementations§
source§impl<I> OnDiskCorpus<I>where
I: Input,
impl<I> OnDiskCorpus<I>where
I: Input,
sourcepub fn new<P>(dir_path: P) -> Result<Self, Error>
pub fn new<P>(dir_path: P) -> Result<Self, Error>
Creates an OnDiskCorpus
.
This corpus stores all testcases to disk.
By default, it stores metadata for each Testcase
as prettified json.
Metadata will be written to a file named .<testcase>.metadata
The metadata may include objective reason, specific information for a fuzz job, and more.
To pick a different metadata format, use OnDiskCorpus::with_meta_format
.
Will error, if std::fs::create_dir_all()
failed for dir_path
.
sourcepub fn with_prefix<P>(
dir_path: P,
prefix: Option<String>
) -> Result<Self, Error>
pub fn with_prefix<P>( dir_path: P, prefix: Option<String> ) -> Result<Self, Error>
Creates the OnDiskCorpus
with a filename prefix.
Will error, if std::fs::create_dir_all()
failed for dir_path
.
sourcepub fn with_meta_format<P>(
dir_path: P,
meta_format: OnDiskMetadataFormat
) -> Result<Self, Error>
pub fn with_meta_format<P>( dir_path: P, meta_format: OnDiskMetadataFormat ) -> Result<Self, Error>
Creates the OnDiskCorpus
specifying the format in which Metadata
will be saved to disk.
Will error, if std::fs::create_dir_all()
failed for dir_path
.
sourcepub fn no_meta<P>(dir_path: P) -> Result<Self, Error>
pub fn no_meta<P>(dir_path: P) -> Result<Self, Error>
Creates an OnDiskCorpus
that will not store .metadata files
Will error, if std::fs::create_dir_all()
failed for dir_path
.
sourcepub fn with_meta_format_and_prefix(
dir_path: &Path,
meta_format: Option<OnDiskMetadataFormat>,
prefix: Option<String>,
locking: bool
) -> Result<Self, Error>
pub fn with_meta_format_and_prefix( dir_path: &Path, meta_format: Option<OnDiskMetadataFormat>, prefix: Option<String>, locking: bool ) -> Result<Self, Error>
Creates a new corpus at the given (non-generic) path with the given optional meta_format
and prefix
.
Will error, if std::fs::create_dir_all()
failed for dir_path
.
Trait Implementations§
source§impl<I> Clone for OnDiskCorpus<I>
impl<I> Clone for OnDiskCorpus<I>
source§fn clone(&self) -> OnDiskCorpus<I>
fn clone(&self) -> OnDiskCorpus<I>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<I> Corpus for OnDiskCorpus<I>where
I: Input,
impl<I> Corpus for OnDiskCorpus<I>where
I: Input,
source§fn add(&mut self, testcase: Testcase<I>) -> Result<CorpusId, Error>
fn add(&mut self, testcase: Testcase<I>) -> Result<CorpusId, Error>
Add an entry to the corpus and return its index
source§fn replace(
&mut self,
idx: CorpusId,
testcase: Testcase<I>
) -> Result<Testcase<I>, Error>
fn replace( &mut self, idx: CorpusId, testcase: Testcase<I> ) -> Result<Testcase<I>, Error>
Replaces the testcase at the given idx
source§fn remove(&mut self, idx: CorpusId) -> Result<Testcase<I>, Error>
fn remove(&mut self, idx: CorpusId) -> Result<Testcase<I>, Error>
Removes an entry from the corpus, returning it if it was present.
source§fn current_mut(&mut self) -> &mut Option<CorpusId>
fn current_mut(&mut self) -> &mut Option<CorpusId>
Current testcase scheduled (mutable)
source§fn load_input_into(
&self,
testcase: &mut Testcase<Self::Input>
) -> Result<(), Error>
fn load_input_into( &self, testcase: &mut Testcase<Self::Input> ) -> Result<(), Error>
Testcase
from persistent storage,
if necessary, and if was not already loaded (== Some(input)
).
After this call, testcase.input()
must always return Some(input)
.source§fn store_input_from(
&self,
testcase: &Testcase<Self::Input>
) -> Result<(), Error>
fn store_input_from( &self, testcase: &Testcase<Self::Input> ) -> Result<(), Error>
Testcase
to persistent storage, if necessary.source§fn ids(&self) -> CorpusIdIterator<'_, Self> ⓘ
fn ids(&self) -> CorpusIdIterator<'_, Self> ⓘ
source§impl<I> Debug for OnDiskCorpus<I>
impl<I> Debug for OnDiskCorpus<I>
source§impl<I> Default for OnDiskCorpus<I>
impl<I> Default for OnDiskCorpus<I>
source§fn default() -> OnDiskCorpus<I>
fn default() -> OnDiskCorpus<I>
source§impl<'de, I> Deserialize<'de> for OnDiskCorpus<I>where
I: Input + DeserializeOwned,
impl<'de, I> Deserialize<'de> for OnDiskCorpus<I>where
I: Input + DeserializeOwned,
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl<I> HasTestcase for OnDiskCorpus<I>where
I: Input,
impl<I> HasTestcase for OnDiskCorpus<I>where
I: Input,
source§impl<I> Serialize for OnDiskCorpus<I>where
I: Input + DeserializeOwned,
impl<I> Serialize for OnDiskCorpus<I>where
I: Input + DeserializeOwned,
Auto Trait Implementations§
impl<I> !RefUnwindSafe for OnDiskCorpus<I>
impl<I> !Send for OnDiskCorpus<I>
impl<I> !Sync for OnDiskCorpus<I>
impl<I> Unpin for OnDiskCorpus<I>
impl<I> !UnwindSafe for OnDiskCorpus<I>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<Tail, T> Prepend<T> for Tail
impl<Tail, T> Prepend<T> for Tail
§type PreprendResult = Tail
type PreprendResult = Tail
TupleList
, of an Prepend::prepend()
call,
including the prepended entry.source§fn prepend(self, value: T) -> (T, <Tail as Prepend<T>>::PreprendResult)
fn prepend(self, value: T) -> (T, <Tail as Prepend<T>>::PreprendResult)
source§impl<T> Serialize for T
impl<T> Serialize for T
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.