Struct podman_api::Podman

pub struct Podman { /* fields omitted */ }

Entrypoint interface for communicating with podman daemon

Implementations

impl Podman

pub fn new<U>(uri: U) -> Result<Podman> where
    U: AsRef<str>, 

Creates a new Podman instance by automatically choosing appropriate connection type based on provided uri.

Supported schemes are:

• unix:// only works when build target is unix, otherwise returns an Error
• tcp://
• http://

To create a Podman instance utilizing TLS use explicit Podman::tls constructor (this requires tls feature enabled).

Uses LATEST_API_VERSION, to use a specific version see Podman::new_versioned.

pub fn new_versioned<U>(
    uri: U,
    version: impl Into<ApiVersion>
) -> Result<Podman> where
    U: AsRef<str>, 

Same as Podman::new but the API version can be explicitly specified.

pub fn unix<P>(socket_path: P) -> Podman where
    P: AsRef<Path>, 

This is supported on Unix only.

Creates a new podman instance for a podman host listening on a given Unix socket.

socket_path is the part of URI that comes after the unix://. For example a URI unix:///run/podman.sock has a socket_path == “/run/podman.sock”.

Uses LATEST_API_VERSION, to use a specific version see Podman::unix_versioned.

pub fn unix_versioned<P>(
    socket_path: P,
    version: impl Into<ApiVersion>
) -> Podman where
    P: AsRef<Path>, 

Same as Podman::unix but the API version can be explicitly specified.

pub fn tls<H, P>(host: H, cert_path: P, verify: bool) -> Result<Podman> where
    H: AsRef<str>,
    P: AsRef<Path>, 

This is supported on crate feature tls only.

Creates a new podman instance for a podman host listening on a given TCP socket host. host is the part of URI that comes after tcp:// or http:// or https:// schemes, also known as authority part.

cert_path specifies the base path in the filesystem containing a certificate (cert.pem) and a key (key.pem) that will be used by the client. If verify is true a CA file will be added (ca.pem) to the connector.

Returns an error if the provided host will fail to parse as URL or reading the certificate files will fail.

Uses LATEST_API_VERSION, to use a specific version see Podman::tls_versioned.

pub fn tls_versioned<H, P>(
    host: H,
    version: impl Into<ApiVersion>,
    cert_path: P,
    verify: bool
) -> Result<Podman> where
    H: AsRef<str>,
    P: AsRef<Path>, 

This is supported on crate feature tls only.

Same as Podman::tls but the API version can be explicitly specified.

pub fn tcp<H>(host: H) -> Result<Podman> where
    H: AsRef<str>, 

Creates a new podman instance for a podman host listening on a given TCP socket host. host is the part of URI that comes after tcp:// or http:// schemes, also known as authority part.

TLS is supported with feature tls enabled through Podman::tls constructor.

Returns an error if the provided host will fail to parse as URL.

Uses LATEST_API_VERSION, to use a specific version see Podman::tcp_versioned.

pub fn tcp_versioned<H>(
    host: H,
    version: impl Into<ApiVersion>
) -> Result<Podman> where
    H: AsRef<str>, 

Same as Podman::tcp but the API version can be explicitly specified.

pub async fn adjust_api_version(&mut self) -> Result<()>

Verifies the API version returned by the server and adjusts the version used by this client in future requests.

pub fn containers(&self) -> Containers<'_>

Api Reference

Returns a handle to podman containers that can be used to operate on them.

pub fn execs(&self) -> Execs<'_>

Api Reference

Returns a handle to podman execs that can be used to operate on them.

pub fn images(&self) -> Images<'_>

Api Reference

Returns a handle to podman images that can be used to operate on them.

pub fn manifests(&self) -> Manifests<'_>

Api Reference

Returns a handle to podman manifests that can be used to operate on them.

pub fn networks(&self) -> Networks<'_>

Api Reference

Returns a handle to podman networks that can be used to operate on them.

pub fn pods(&self) -> Pods<'_>

Api Reference

Returns a handle to podman pods that can be used to operate on them.

pub fn volumes(&self) -> Volumes<'_>

Api Reference

Returns a handle to podman volumes that can be used to operate on them.

pub fn secrets(&self) -> Secrets<'_>

Api Reference

Returns a handle to podman secrets that can be used to operate on them.

pub async fn info(&self) -> Result<HostInfo>

Api Reference

Returns information on the system and libpod configuration

pub async fn ping(&self) -> Result<LibpodPingInfo>

Api Reference

Return protocol information from libpod.

pub async fn version(&self) -> Result<LibpodVersionResponse>

Api Reference

Returns component version information.

pub async fn data_usage(&self) -> Result<LibpodDataUsageResponse>

Api Reference

Return information about disk usage for containers, images, and volumes.

pub async fn prune(&self) -> Result<LibpodSystemPruneResponse>

Api Reference

Prune unused data.

pub fn events<'libpod>(
    &'libpod self,
    opts: &EventsOpts
) -> impl Stream<Item = Result<Event>> + Unpin + 'libpod

Api Reference

Returns system events

Trait Implementations

impl Clone for Podman

fn clone(&self) -> Podman

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Podman

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.