Skip to main content

OpenOptions

Struct OpenOptions 

Source
pub struct OpenOptions {
    pub batch_size: usize,
    pub follow_symlinks: bool,
    pub one_filesystem: bool,
    pub hidden: Option<Arc<HiddenPolicy>>,
    pub exclude_special: bool,
    pub types: Option<Arc<TypeRegistry>>,
    pub budget: DiscoveryBudget,
    pub observation: Option<WatchConfig>,
    pub journal_capacity_bytes: usize,
    pub control_limits: ControlLimits,
}
Expand description

Configuration for a long-lived OpenedIndex.

Scope and execution settings are flat here because each is one independent decision; display depth is absent by design and belongs to a read request. The options bind progressive discovery, exact-history bounds, and optional live observation without changing the one-shot API.

Fields§

§batch_size: usize

Ops per committed discovery batch.

§follow_symlinks: bool

Follow directory symlinks when the configured platform semantics support it.

§one_filesystem: bool

Stay on the filesystem containing the opened root.

§hidden: Option<Arc<HiddenPolicy>>

Hidden-component admission, or None to retain every component.

§exclude_special: bool

Exclude objects other than files, directories, and symlinks.

§types: Option<Arc<TypeRegistry>>

File-type rules, or None for the rules compiled into fdu.

§budget: DiscoveryBudget

Resource policy for the cold progressive walk.

§observation: Option<WatchConfig>

Optional filesystem observation captured before cold discovery begins.

§journal_capacity_bytes: usize

Approximate bytes the exact commit journal may retain, as crate::Commit::retained_cost estimates them; see crate::DEFAULT_JOURNAL_CAPACITY_BYTES for the default and why there is no unbounded setting. OpenedIndex::open refuses a budget below crate::MIN_JOURNAL_CAPACITY_BYTES with Error::JournalCapacityTooSmall.

§control_limits: ControlLimits

The budget and the line limit .gitignore files are applied under. See ScanConfig::control_limits: a refused file ends nothing, and crate::ReadDiagnostics::controls names it and the limit that fired.

Implementations§

Source§

impl OpenOptions

Source

pub fn plan(&self, root: &Path, delivery: &Delivery) -> Result<Plan>

Construct a validated cold-progressive plan from these options and a delivery.

Trait Implementations§

Source§

impl Clone for OpenOptions

Source§

fn clone(&self) -> Self

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 Debug for OpenOptions

Source§

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

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

impl Default for OpenOptions

Source§

fn default() -> Self

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

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.