Struct IncludeRequest 

#[non_exhaustive]
pub struct IncludeRequest<'a> {
    pub spec: &'a str,
    pub from_name: &'a str,
    pub from_id: Option<&'a str>,
    pub stack: Vec<String>,
    pub size_remaining: Option<usize>,
    pub location: Location,
}

A request passed to the include resolver to resolve an include directive.

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.

spec: &'a str

The include specification (e.g. the path or URL).

from_name: &'a str

The name of the file or source currently being parsed (top of the include stack).

from_id: Option<&'a str>

The canonical identity of the source currently being parsed, or None for the root parser.

stack: Vec<String>

The full chain of inclusions leading to this request, with the current file at the end.

size_remaining: Option<usize>

Remaining decoded byte quota available for additional reader-backed input, if configured.

location: Location

The location in the source file where the include was requested.

Implementations

impl<'a> IncludeRequest<'a>

pub fn new(spec: &'a str, from_name: &'a str, location: Location) -> Self

Construct a root-level include request.

This is primarily useful when testing a resolver directly. Parser-created requests populate the same fields and may include parent-source and budget metadata.

pub fn with_from_id(self, from_id: &'a str) -> Self

Set the canonical identity of the source containing the include.

pub fn with_stack(self, stack: Vec<String>) -> Self

Set the include chain leading to this request.

pub fn with_size_remaining(self, size_remaining: usize) -> Self

Set the remaining reader-input byte budget.

Trait Implementations

impl<'a> Debug for IncludeRequest<'a>

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

Formats the value using the given formatter.