Struct docker_api::plugin::Plugin

pub struct Plugin<'docker> { /* fields omitted */ }

Interface for accessing and manipulating a Docker plugin.

Api Reference: https://docs.docker.com/engine/api/v1.41/#tag/Plugin

Implementations

impl<'docker> Plugin<'docker>

pub fn new<S>(docker: &'docker Docker, name: S) -> Self where
    S: Into<String>, 

Exports an interface for operations that may be performed against a named image.

pub async fn inspect(&self) -> Result<PluginInfo>

Inspects a named plugin’s details.

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/PluginInspect

pub async fn remove(&self) -> Result<PluginInfo>

Removes a plugin.

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/PluginDelete

pub async fn force_remove(&self) -> Result<PluginInfo>

Forcefully remove a plugin. This may result in issues if the plugin is in use by a container.

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/PluginDelete

pub async fn enable(&self, timeout: Option<u64>) -> Result<()>

Enable a plugin.

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/PluginEnable

pub async fn disable(&self) -> Result<()>

Disable a plugin.

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/PluginDisable

pub async fn push(&self) -> Result<()>

Push a plugin to the registry.

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/PluginPush

pub async fn create<P>(&self, path: P) -> Result<()> where
    P: AsRef<Path>, 

Create a plugin from a tar archive on the file system. The path parameter is a path to the tar containing plugin rootfs and manifest.

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/PluginCreate

Trait Implementations

impl<'docker> Debug for Plugin<'docker>

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

Formats the value using the given formatter.