Skip to main content

LifecyclePlan

Struct LifecyclePlan 

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

Topologically sorted execution plan.

Built by LifecyclePlan::from_manifest and consumed by crate::LifecycleManager. The node order guarantees that every resource appears after all of its direct and transitive dependencies.

§Example

use lightshuttle_manifest::Manifest;
use lightshuttle_runtime::LifecyclePlan;

let yaml = r#"
project:
  name: myapp
resources:
  db:
    postgres:
      version: "16"
  api:
    container:
      image: myapp:latest
      depends_on: [db]
"#;

let manifest = Manifest::parse(yaml).expect("valid manifest");
let plan = LifecyclePlan::from_manifest(&manifest)?;

// Nodes are sorted: "db" appears before "api".
for node in plan.nodes() {
    println!("{} ({}) -> {:?}", node.name, node.kind, node.depends_on);
}

Implementations§

Source§

impl LifecyclePlan

Source

pub fn env_report(&self, extra_env: &HashMap<String, String>) -> EnvReport

Classify every ${env.*} reference in this plan against the ambient process environment plus extra_env (which takes precedence).

Only environment values and command arguments are scanned because those are the only sites the runtime interpolates at start time. References in image tags or working directories are intentionally excluded.

The resolution logic delegates to the same Interpolator the runtime uses, so an empty value counts as unset and the report mirrors what a real start_all call would do. This makes the report suitable as both a preflight check (called by crate::LifecycleManager::check_required_env) and a diagnostic tool (called by lightshuttle secrets check).

The extra_env argument carries the contents of the loaded .env file. Entries in extra_env with an empty string value are treated as unset.

Source§

impl LifecyclePlan

Source

pub fn from_manifest(manifest: &Manifest) -> Result<Self, LifecycleError>

Build a plan from a parsed manifest.

Resolves the dependency graph, performs a topological sort (Kahn’s algorithm) and converts every resource to a ContainerSpec.

§Errors

Returns crate::LifecycleError::Cycle when the dependency graph contains a cycle, crate::LifecycleError::ResourceNotFound when a resource references an unknown dependency, and crate::LifecycleError::SpecBuild when a resource cannot be converted to a ContainerSpec.

Source

pub fn nodes(&self) -> &[PlanNode]

Returns the nodes in topological order.

A node is guaranteed to appear after every node it depends on. The crate::LifecycleManager iterates this slice to start resources in order, spawning independent branches concurrently.

Source

pub fn dependents_of(&self, name: &str) -> Vec<&str>

Returns the names of resources that directly depend on name, sorted alphabetically.

Used during teardown to determine which downstream resources must be stopped before their dependency can be removed.

Trait Implementations§

Source§

impl Clone for LifecyclePlan

Source§

fn clone(&self) -> LifecyclePlan

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 LifecyclePlan

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<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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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