Struct libafl::corpus::inmemory_ondisk::InMemoryOnDiskCorpus

impl InMemoryOnDiskCorpus
where I: Input,

pub fn new(dir_path: P) -> Result<Self, Error>
where P: AsRef<Path>,

Creates an InMemoryOnDiskCorpus.

This corpus stores all testcases to disk, and keeps all of them in memory, as well.

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.

If you don’t want metadata, use InMemoryOnDiskCorpus::no_meta. To pick a different metadata format, use InMemoryOnDiskCorpus::with_meta_format.

Will error, if std::fs::create_dir_all() failed for dir_path.

pub fn with_meta_format( dir_path: P, meta_format: Option<OnDiskMetadataFormat> ) -> Result<Self, Error>
where P: AsRef<Path>,

Creates the InMemoryOnDiskCorpus specifying the format in which Metadata will be saved to disk.

Will error, if std::fs::create_dir_all() failed for dir_path.

pub fn with_meta_format_and_prefix( dir_path: P, meta_format: Option<OnDiskMetadataFormat>, prefix: Option<String>, locking: bool ) -> Result<Self, Error>
where P: AsRef<Path>,

Creates the InMemoryOnDiskCorpus specifying the format in which Metadata will be saved to disk and the prefix for the filenames.

Will error, if std::fs::create_dir_all() failed for dir_path.

pub fn no_meta(dir_path: P) -> Result<Self, Error>
where P: AsRef<Path>,

Creates an InMemoryOnDiskCorpus that will not store .metadata files

Will error, if std::fs::create_dir_all() failed for dir_path.

pub fn rename_testcase( &self, testcase: &mut Testcase, filename: String ) -> Result<(), Error>

Sets the filename for a Testcase. If an error gets returned from the corpus (i.e., file exists), we’ll have to retry with a different filename.

pub fn dir_path(&self) -> &PathBuf

Path to the corpus directory associated with this corpus

Trait Implementations§

impl Clone for InMemoryOnDiskCorpus
where I: Input + Clone,

fn clone(&self) -> InMemoryOnDiskCorpus

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Corpus for InMemoryOnDiskCorpus
where I: Input,

fn count(&self) -> usize

Returns the number of elements

fn add(&mut self, testcase: Testcase) -> Result<CorpusId, Error>

Add an entry to the corpus and return its index

fn replace( &mut self, idx: CorpusId, testcase: Testcase ) -> Result<Testcase, Error>

Replaces the testcase at the given idx

fn remove(&mut self, idx: CorpusId) -> Result<Testcase, Error>

Removes an entry from the corpus, returning it if it was present.

fn get(&self, idx: CorpusId) -> Result<&RefCell<Testcase>, Error>

Get by id

fn current(&self) -> &Option<CorpusId>

Current testcase scheduled

fn current_mut(&mut self) -> &mut Option<CorpusId>

Current testcase scheduled (mutable)

fn next(&self, idx: CorpusId) -> Option<CorpusId>

Get the next corpus id

fn prev(&self, idx: CorpusId) -> Option<CorpusId>

Get the prev corpus id

fn first(&self) -> Option<CorpusId>

Get the first inserted corpus id

fn last(&self) -> Option<CorpusId>

Get the last inserted corpus id

fn nth(&self, nth: usize) -> CorpusId

Get the nth corpus id

fn load_input_into( &self, testcase: &mut Testcase<Self::Input> ) -> Result<(), Error>

Method to load the input for this Testcase from persistent storage, if necessary, and if was not already loaded (== Some(input)). After this call, testcase.input() must always return Some(input).

fn store_input_from( &self, testcase: &Testcase<Self::Input> ) -> Result<(), Error>

Method to store the input of this Testcase to persistent storage, if necessary.

fn is_empty(&self) -> bool

Returns true, if no elements are in this corpus yet

fn ids(&self) -> CorpusIdIterator<'_, Self> ⓘ

An iterator over very active corpus id

fn cloned_input_for_id(&self, idx: CorpusId) -> Result<Self::Input, Error>

Loads the Input for a given CorpusId from the Corpus, and returns the clone.

impl Debug for InMemoryOnDiskCorpus
where I: Input + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for InMemoryOnDiskCorpus
where I: Input + Default,

fn default() -> InMemoryOnDiskCorpus

Returns the “default value” for a type. Read more

impl<'de, I> Deserialize<'de> for InMemoryOnDiskCorpus
where I: Input + DeserializeOwned,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl HasTestcase for InMemoryOnDiskCorpus
where I: Input,

fn testcase( &self, id: CorpusId ) -> Result<Ref<'_, Testcase<<Self as UsesInput>::Input>>, Error>

Shorthand to receive a Ref to a stored Testcase, by CorpusId. For a normal state, this should return a Testcase in the corpus, not the objectives.

fn testcase_mut( &self, id: CorpusId ) -> Result<RefMut<'_, Testcase<<Self as UsesInput>::Input>>, Error>

Shorthand to receive a RefMut to a stored Testcase, by CorpusId. For a normal state, this should return a Testcase in the corpus, not the objectives.

impl Serialize for InMemoryOnDiskCorpus
where I: Input + DeserializeOwned,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl UsesInput for InMemoryOnDiskCorpus
where I: Input,

type Input = I

Type which will be used throughout this state.

Auto Trait Implementations§

impl !UnwindSafe for InMemoryOnDiskCorpus

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows 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) -> R
where R: 'a,

Mutably borrows 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
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows 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
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<Tail, T> Prepend<T> for Tail

type PreprendResult = Tail

The Resulting TupleList, of an Prepend::prepend() call, including the prepended entry.

fn prepend(self, value: T) -> (T, <Tail as Prepend<T>>::PreprendResult)

Prepend a value to this tuple, returning a new tuple with prepended value.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Serialize for T
where T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more