Skip to main content

ResolveConfig

Struct ResolveConfig 

Source
pub struct ResolveConfig {
    pub root: PathBuf,
    pub max_depth: usize,
    pub max_total_includes: usize,
}
Expand description

Configuration for the include resolution pass.

Fields§

§root: PathBuf

Directory all include paths resolve under. Any include that canonicalizes outside this root is a IncludeError::RootEscape.

Must be an absolute path. Lexical normalization treats . and .. against an empty buffer as no-ops; passing a relative or unnormalized root weakens the root-escape prefix check. Callers (CLI, LSP) should canonicalize the root before constructing ResolveConfig.

§max_depth: usize

Maximum include depth. Default 8 (see ResolveConfig::DEFAULT_MAX_DEPTH). Hitting the limit is an error, not a silent truncation.

§max_total_includes: usize

Maximum total number of lex.include annotations resolved across the whole tree (depth × breadth). Default 1000 (see ResolveConfig::DEFAULT_MAX_TOTAL_INCLUDES).

Caps fan-out: max_depth alone bounds chain length but not breadth. A document with 100 thousand top-level includes at depth 1 sits inside max_depth but can still OOM the resolver / LSP / CI. Hitting this limit is an error, not a silent truncation.

Implementations§

Source§

impl ResolveConfig

Source

pub const DEFAULT_MAX_DEPTH: usize = 8

Default maximum include depth — enough for any reasonable atomization strategy (aggregator → per-chapter → per-section), bounded enough to keep the resolver’s worst-case work predictable.

Source

pub const DEFAULT_MAX_TOTAL_INCLUDES: usize = 1000

Default maximum total include count (DoS bound). Generous enough for a book-length document with thousands of small fragments, tight enough to contain adversarial fan-out within a few seconds of resolver work.

Source

pub fn with_root(root: PathBuf) -> Self

Construct a config with the given root and default limits.

Trait Implementations§

Source§

impl Clone for ResolveConfig

Source§

fn clone(&self) -> ResolveConfig

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 ResolveConfig

Source§

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

Formats the value using the given formatter. 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> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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