Struct docker_api::api::plugin::Plugin

pub struct Plugin { /* private fields */ }

Available on crate feature swarm only.

Interface for accessing and manipulating Docker Plugin.

Api Reference

Implementations

impl Plugin

pub fn new(docker: Docker, name: impl Into<Id>) -> Self

Exports an interface exposing operations against a Plugin instance.

pub fn name(&self) -> &Id

A getter for Plugin name

impl Plugin

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

Api Reference

Inspect this Plugin.

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

Api Reference

Delete this Plugin.

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

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 Debug for Plugin

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

Formats the value using the given formatter.