Skip to main content

DockerClient

Struct DockerClient 

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

Docker client wrapper with connection handling

Implementations§

Source§

impl DockerClient

Source

pub fn new() -> Result<Self, DockerError>

Create new client connecting to local Docker daemon

Uses platform-appropriate socket (Unix socket on Linux/macOS). Returns a clear error if Docker is not running or accessible.

Source

pub fn with_timeout(timeout_secs: u64) -> Result<Self, DockerError>

Create client with custom timeout (in seconds)

Use for long-running operations like image builds. Default timeout is 120 seconds; build timeout should be 600+ seconds.

Source

pub async fn connect_remote( host: &HostConfig, host_name: &str, ) -> Result<Self, DockerError>

Create client connecting to remote Docker daemon via SSH tunnel

Establishes an SSH tunnel to the remote host and connects Bollard to the forwarded local port.

§Arguments
  • host - Remote host configuration
  • host_name - Name of the host (for display purposes)
Source

pub async fn connect_remote_with_timeout( host: &HostConfig, host_name: &str, timeout_secs: u64, ) -> Result<Self, DockerError>

Create remote client with custom timeout

Source

pub async fn verify_connection(&self) -> Result<(), DockerError>

Verify connection to Docker daemon

Returns Ok(()) if connected, descriptive error otherwise.

Source

pub async fn version(&self) -> Result<String, DockerError>

Get Docker version info (useful for debugging)

Source

pub fn host_name(&self) -> Option<&str>

Get the host name if this is a remote connection

Source

pub fn is_remote(&self) -> bool

Check if this is a remote connection

Source

pub fn inner(&self) -> &Docker

Access inner Bollard client for advanced operations

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<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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