Struct DetectOptions 

#[non_exhaustive]
pub struct DetectOptions {
    pub base: u64,
}

Where to look for a filesystem, and anything else detection needs to be told.

Every input to detect_with is a field here rather than a parameter, so an input detection grows arrives as a field a caller may ignore.

// The filesystem in a partition that begins one mebibyte into a whole-disk image.
let options = DetectOptions::new().base(1 << 20);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

base: u64

Byte offset within the source at which the filesystem begins — zero for a bare image, the partition’s start for one inside a disk image, and wherever a carver located a candidate region.

Offset is a first-class concept everywhere a filesystem is read, and it is one here for the same reason: the question detection answers is “what is at this location”, which a classifier fixed to the start of its source cannot be asked.

Implementations

impl DetectOptions

pub const fn new() -> Self

Detect at the start of the source.

pub const fn base(self, base: u64) -> Self

Detect a filesystem that begins base bytes into the source.

Trait Implementations

impl Clone for DetectOptions

fn clone(&self) -> DetectOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DetectOptions

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

Formats the value using the given formatter.

impl Default for DetectOptions

fn default() -> DetectOptions

Returns the “default value” for a type.

impl PartialEq for DetectOptions

fn eq(&self, other: &DetectOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DetectOptions

impl Eq for DetectOptions

impl StructuralPartialEq for DetectOptions