Skip to main content

DetectOptions

Struct DetectOptions 

Source
#[non_exhaustive]
pub struct DetectOptions { pub base: u64, pub len: Option<u64>, }
Expand description

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 16 MiB partition that begins one mebibyte into a whole-disk image.
let options = DetectOptions::new().base(1 << 20).len(16 << 20);

Fields (Non-exhaustive)§

This struct is marked as 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.

§len: Option<u64>

How many bytes from base on the region holds, or None for every byte to the source’s end — the same region OpenOptions::len names to a reader.

Detection reads through the region alone: the source ends at the region’s end, so no byte past it is read as the filesystem’s.

Implementations§

Source§

impl DetectOptions

Source

pub const fn new() -> Self

Detect at the start of the source.

Source

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

Detect a filesystem that begins base bytes into the source.

Source

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

Detect a filesystem within the len bytes from its base on.

Trait Implementations§

Source§

impl Clone for DetectOptions

Source§

fn clone(&self) -> DetectOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for DetectOptions

Source§

impl Debug for DetectOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for DetectOptions

Source§

fn default() -> DetectOptions

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

impl Eq for DetectOptions

Source§

impl PartialEq for DetectOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DetectOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.