Skip to main content

ComposeProject

Struct ComposeProject 

Source
pub struct ComposeProject {
    pub name: String,
    pub config: ComposeConfig,
    pub service_order: Vec<String>,
    pub service_boxes: HashMap<String, String>,
    pub networks: Vec<String>,
    pub base_dir: PathBuf,
}
Expand description

A running compose project.

Fields§

§name: String

Project name (derived from directory name or –project-name).

§config: ComposeConfig

The parsed compose config.

§service_order: Vec<String>

Service boot order (topologically sorted).

§service_boxes: HashMap<String, String>

Map of service name → box ID (once started).

§networks: Vec<String>

Networks created for this project.

§base_dir: PathBuf

Base directory used to resolve relative env_file paths.

Implementations§

Source§

impl ComposeProject

Source

pub fn new(name: impl Into<String>, config: ComposeConfig) -> Result<Self>

Create a new compose project from a config.

Validates the config and computes the service boot order.

Source

pub fn with_base_dir( name: impl Into<String>, config: ComposeConfig, base_dir: impl Into<PathBuf>, ) -> Result<Self>

Create a compose project with an explicit base directory.

Source

pub fn state(&self) -> ProjectState

Get the project state based on which services have box IDs.

Source

pub fn build_box_config( &self, service_name: &str, default_network: Option<&str>, ) -> Result<BoxConfig>

Build a BoxConfig for a single service.

Translates compose service fields into the BoxConfig used by VmManager.

Source

pub fn default_network_name(&self) -> String

Get the network name for this project’s default network.

Source

pub fn required_networks(&self) -> Vec<String>

Get all network names this project needs (project-prefixed).

Source

pub fn register_service(&mut self, service_name: &str, box_id: String)

Record that a service has been started with the given box ID.

Source

pub fn unregister_service(&mut self, service_name: &str)

Remove a service’s box ID (on stop/destroy).

Source

pub fn box_id(&self, service_name: &str) -> Option<&str>

Get the box ID for a service, if running.

Source

pub fn shutdown_order(&self) -> Vec<String>

Get the shutdown order (reverse of boot order).

Source

pub fn health_wait_deps(&self, service_name: &str) -> Vec<String>

Check if a service requires its dependencies to be healthy before starting.

Returns the list of dependency service names that must reach “healthy” status.

Source

pub fn completed_wait_deps(&self, service_name: &str) -> Vec<String>

Dependencies this service must wait to run to completion (exit 0) before starting — depends_on: { dep: { condition: service_completed_successfully } }.

Source

pub fn healthcheck(&self, service_name: &str) -> Option<HealthCheckSpec>

Get the health check config for a service, if defined.

Source

pub fn healthcheck_disabled(&self, service_name: &str) -> bool

Return true when a service explicitly disables its health check.

Trait Implementations§

Source§

impl Clone for ComposeProject

Source§

fn clone(&self) -> ComposeProject

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 ComposeProject

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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