Struct docker_api::api::plugin::Plugin

source · [−]

pub struct Plugin { /* private fields */ }

Available on crate feature swarm only.

Expand description

Interface for accessing and manipulating Docker Plugin.

Api Reference

Implementations

source

impl Plugin

source

pub fn new<ID>(docker: Docker, name: ID) -> Self where
ID: Into<PluginId>,

Exports an interface exposing operations against a Plugin instance.

source

pub fn name(&self) -> PluginIdRef<'_>

A getter for Plugin name

source

impl Plugin

source

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

Api Reference

Inspect this Plugin.

source

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

Api Reference

Delete this Plugin.

source

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

Api Reference

Delete this Plugin.

source

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

Api Reference

Enable a plugin.

source

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

Api Reference

Disable a plugin.

source

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

Api Reference

Push a plugin to the registry.

source

pub async fn create(&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

source

impl Debug for Plugin

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Plugin

impl Send for Plugin

impl Sync for Plugin

impl Unpin for Plugin

impl !UnwindSafe for Plugin

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

Struct docker_api::api::plugin::Plugin

Implementations

impl Plugin

pub fn new<ID>(docker: Docker, name: ID) -> Self where ID: Into<PluginId>,

pub fn name(&self) -> PluginIdRef<'_>

impl Plugin

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

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

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

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

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

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

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

Trait Implementations

impl Debug for Plugin

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

Auto Trait Implementations

impl !RefUnwindSafe for Plugin

impl Send for Plugin

impl Sync for Plugin

impl Unpin for Plugin

impl !UnwindSafe for Plugin

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new<ID>(docker: Docker, name: ID) -> Self where
ID: Into<PluginId>,

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,