Skip to main content

DockerRuntime

Struct DockerRuntime 

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

Docker container runtime backed by the bollard crate.

Connects to the local Docker daemon using the platform default transport (Unix socket on Linux and macOS, named pipe on Windows).

Implementations§

Source§

impl DockerRuntime

Source

pub fn connect() -> Result<Self>

Connect to the local Docker daemon.

Source

pub fn from_client(client: Docker) -> Self

Wrap an existing bollard::Docker client. Useful for tests that supply a pre-configured client (custom transport, mock, etc.).

Source

pub async fn list_managed(&self, project: &str) -> Result<Vec<ManagedContainer>>

List every container labelled with lightshuttle.project=<project>, including stopped ones. Used by the CLI to implement ps and down without relying on in-memory state.

Trait Implementations§

Source§

impl ContainerRuntime for DockerRuntime

Source§

async fn ensure_project_network(&self, project: &str) -> Result<()>

Ensure a per-project user-defined bridge network exists, creating it when absent. Idempotent: concurrent calls are safe because a 409 Conflict response (network already exists) is treated as success. Containers attached to this network can reach each other by their container name, enabling resources.<name>.url hostnames to resolve without extra configuration.
Source§

async fn teardown_project_network(&self, project: &str) -> Result<()>

Remove the per-project bridge network. Idempotent: a 404 Not Found response is treated as success. Call after all containers belonging to the project have been removed; Docker refuses to delete a network that still has active endpoints.
Source§

async fn start(&self, spec: &ContainerSpec) -> Result<ContainerId>

Start a container according to spec. Pulls the image if not already present locally.
Source§

async fn stop(&self, id: &ContainerId, grace: Duration) -> Result<()>

Stop a container, sending SIGTERM and then SIGKILL after grace. Idempotent: stopping an already stopped container is a no-op.
Source§

async fn remove(&self, name: &str) -> Result<()>

Remove a container by name, forcing removal even if it is still running. Idempotent: removing a container that does not exist is a no-op. Named volumes are preserved. Read more
Source§

async fn inspect(&self, id: &ContainerId) -> Result<ContainerStatus>

Report the current status of a container.
Source§

async fn wait_healthy(&self, id: &ContainerId, timeout: Duration) -> Result<()>

Block until the container reports a healthy status or timeout elapses. Returns crate::RuntimeError::Timeout in the latter case.
Source§

async fn logs(&self, id: &ContainerId, follow: bool) -> Result<LogChunkStream>

Stream logs from a container. When follow is true the stream stays open and emits new chunks as they arrive; when false the stream completes after the existing logs are drained.

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> 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> 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, 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