Skip to main content

IncludeRequest

Struct IncludeRequest 

Source
pub struct IncludeRequest { /* private fields */ }
Expand description

One effective, caller-authorized include request.

Every path-like value remains raw source data in declared order. The loader receives this complete context and alone decides whether and how any document may be obtained.

Implementations§

Source§

impl IncludeRequest

Source

pub const fn parent_identity(&self) -> &IncludeIdentity

Returns the identity of the project that declared this request.

Source

pub fn parent_base_directory(&self) -> &Path

Returns the parent project’s first-document directory exactly as supplied by the caller.

Source

pub const fn declaration_span(&self) -> SourceSpan

Returns the complete span of the effective declaration.

Source

pub const fn declaration_source_id(&self) -> SourceId

Returns the source identifier containing the effective declaration.

Source

pub const fn declaration_origin(&self) -> Option<&DocumentOrigin>

Returns the origin of the document containing the effective declaration, when available.

Source

pub const fn item(&self) -> &IncludeItem

Returns the complete effective typed include item without interpolation.

Source

pub fn paths(&self) -> &[Located<String>]

Returns raw include paths in declared order.

Source

pub fn env_files(&self) -> &[Located<String>]

Returns raw include environment-file declarations in declared order.

Source

pub const fn project_directory(&self) -> Option<&Located<String>>

Returns the raw optional project-directory declaration.

Trait Implementations§

Source§

impl Clone for IncludeRequest

Source§

fn clone(&self) -> IncludeRequest

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 IncludeRequest

Source§

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

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

impl Eq for IncludeRequest

Source§

impl PartialEq for IncludeRequest

Source§

fn eq(&self, other: &IncludeRequest) -> 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 IncludeRequest

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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.