Struct ControlState 

pub struct ControlState<H>
where
    H: LifecycleHandle + Clone,
{
    pub project: String,
    pub handle: H,
    /* private fields */
}

Shared state injected into every route of the control plane.

Constructed once and cloned into the axum router via axum::Router::with_state. All fields that route handlers need are either pub or exposed through the constructors below.

Use ControlState::new for tests and embedders that do not need Prometheus metrics, and ControlState::with_metrics for production use where GET /metrics must return live data.

Fields

project: String

Project name as declared in the manifest.

Shown in the dashboard title and returned by GET /healthz.

handle: H

Lifecycle handle backing the resource endpoints.

Handlers call lightshuttle_runtime::LifecycleHandle::list, lightshuttle_runtime::LifecycleHandle::get, lightshuttle_runtime::LifecycleHandle::restart, lightshuttle_runtime::LifecycleHandle::logs, and lightshuttle_runtime::LifecycleHandle::subscribe_events through this field.

Implementations

impl<H> ControlState<H>

where H: LifecycleHandle + Clone,

pub fn new(project: impl Into<String>, handle: H) -> Self

Build state with a non-installing crate::Metrics handle.

The attached crate::Metrics does not install a global recorder, so the metrics! macros write nowhere and GET /metrics renders an empty snapshot. This constructor is intended for tests and for embedders that do not need to serve metrics. In production, install the recorder once with crate::Metrics::install and use Self::with_metrics to pass the live handle.

pub fn with_metrics( project: impl Into<String>, handle: H, metrics: Arc<Metrics>, ) -> Self

Build state bound to an existing crate::Metrics renderer.

Use this constructor in production when you have already called crate::Metrics::install and wrapped the result in an Arc. GET /metrics will then render live counters and gauges.

The Arc is cheap to clone across axum route handlers.

Trait Implementations

impl<H> Clone for ControlState<H>

where H: LifecycleHandle + Clone + Clone,

fn clone(&self) -> ControlState<H>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.