Skip to main content

LoadedProject

Struct LoadedProject 

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

An ordered set of parsed Compose documents and their path origins.

File order is semantically significant. The first document supplies the project directory used by Compose’s multi-file relative-path rules, while every document retains its own origin for provenance and future include support.

Implementations§

Source§

impl LoadedProject

Source

pub fn load( inputs: impl IntoIterator<Item = DocumentInput>, ) -> Result<Self, ProjectLoadError>

Parses ordered, caller-supplied documents into a loaded project.

Recoverable YAML and typed-model problems remain available in Self::diagnostics. No interpolation or merge is performed by this operation.

§Errors

Returns ProjectLoadError when no document is supplied, a source identifier is reused, or one source exceeds the syntax tree’s byte-offset capacity.

Source

pub fn documents(&self) -> &[LoadedDocument]

Returns documents in caller-supplied merge order.

Source

pub fn document(&self, source_id: SourceId) -> Option<&LoadedDocument>

Finds a document by its unique source identifier.

Source

pub fn base_directory(&self) -> &Path

Returns the project directory inherited from the first document.

Source

pub fn diagnostics(&self) -> &[Diagnostic]

Returns aggregated syntax and typed-model diagnostics in document order.

Source

pub fn is_valid(&self) -> bool

Reports whether loading emitted no error diagnostics.

Source

pub fn interpolate( &self, environment: &dyn EnvironmentProvider, ) -> ProjectInterpolation

Interpolates each document independently, in file order, without modifying the project.

Source

pub fn interpolate_with_options( &self, environment: &dyn EnvironmentProvider, options: InterpolationOptions, ) -> ProjectInterpolation

Interpolates each document independently with explicit options.

Trait Implementations§

Source§

impl Clone for LoadedProject

Source§

fn clone(&self) -> LoadedProject

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 LoadedProject

Source§

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

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

impl Eq for LoadedProject

Source§

impl PartialEq for LoadedProject

Source§

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

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.