Struct docker_api::api::plugin::Plugin

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

This is supported on crate feature swarm only.

Interface for accessing and manipulating Docker Plugin.

Api Reference

Implementations

impl<'docker> Plugin<'docker>

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

Exports an interface exposing operations against a Plugin instance.

pub fn name(&self) -> &str

A getter for Plugin name

impl<'docker> Plugin<'docker>

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

Api Reference

Inspect this Plugin.

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

Api Reference

Delete this Plugin.

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

Api Reference

Delete this Plugin.

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

Api Reference

Enable a plugin.

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

Api Reference

Disable a plugin.

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

Api Reference

Push a plugin to the registry.

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

Api Reference

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.

Trait Implementations

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

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

Formats the value using the given formatter.