Skip to main content

ComposeDocument

Struct ComposeDocument 

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

A source-aware native Compose document.

Implementations§

Source§

impl ComposeDocument

Source

pub fn parse(syntax: &SyntaxDocument) -> ModelParse

Extracts the initial typed Compose subset from a loss-aware syntax document.

Parsing does not interpolate values, apply defaults, normalize short and long forms, or access the environment. Structural problems produce diagnostics and as much typed data as can be recovered.

Source

pub const fn source_id(&self) -> SourceId

Returns the source identifier.

Source

pub const fn span(&self) -> SourceSpan

Returns the typed root mapping span.

Source

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

Returns the explicitly authored project name.

Source

pub fn services(&self) -> &[Service]

Returns services in authored order.

Source

pub fn service(&self, name: &str) -> Option<&Service>

Finds the first service with the requested name.

Source

pub fn validate_dependencies(&self) -> Vec<Diagnostic>

Validates dependency targets and service_healthy health-check requirements in this document.

Multi-file callers should validate the merged project view through crate::resolution::validate_references instead.

Source

pub fn networks(&self) -> &[NetworkDefinition]

Returns top-level network definitions in authored order.

Source

pub fn volumes(&self) -> &[VolumeDefinition]

Returns top-level volume definitions in authored order.

Source

pub fn configs(&self) -> &[ConfigDefinition]

Returns top-level config definitions in authored order.

Source

pub fn secrets(&self) -> &[SecretDefinition]

Returns top-level secret definitions in authored order.

Source

pub fn extension_fields(&self) -> &[FieldReference]

Returns retained top-level x- extension fields.

Source

pub fn unknown_fields(&self) -> &[FieldReference]

Returns top-level fields not yet represented by the typed subset.

Trait Implementations§

Source§

impl Clone for ComposeDocument

Source§

fn clone(&self) -> ComposeDocument

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 ComposeDocument

Source§

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

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

impl Eq for ComposeDocument

Source§

impl PartialEq for ComposeDocument

Source§

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

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.