Struct Pyo3Plugin 

pub struct Pyo3Plugin { /* private fields */ }

Represents an individual Docker plugin.

Provides methods to inspect, enable, disable, and manage plugins.

Implementations

impl Pyo3Plugin

pub fn new(docker: Pyo3Docker, name: &str) -> Self

pub fn name(&self) -> String

Get the plugin name.

Returns: str: Plugin name

pub fn inspect(&self) -> PyResult<Py<PyAny>>

Inspect the plugin to get detailed information.

Returns: dict: Detailed plugin information including: - id: Plugin ID - name: Plugin name - enabled: Whether the plugin is enabled - settings: Plugin settings (mounts, env, args, devices) - plugin_reference: Plugin reference - config: Full plugin configuration

Raises: SystemError: If the operation fails

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

Enable the plugin.

Enables a previously disabled plugin so it can be used by Docker.

Args: timeout: Timeout in seconds to wait for enable (optional)

Returns: None

Raises: SystemError: If the plugin cannot be enabled

pub fn disable(&self) -> PyResult<()>

Disable the plugin.

Disables a running plugin. The plugin must be disabled before it can be removed.

Returns: None

Raises: SystemError: If the plugin cannot be disabled

pub fn remove(&self) -> PyResult<Py<PyAny>>

Remove (delete) the plugin.

Removes the plugin from Docker. The plugin must be disabled first. Use force_remove() to remove an enabled plugin.

Returns: dict: Information about the removed plugin

Raises: SystemError: If the plugin cannot be removed (e.g., still enabled)

pub fn force_remove(&self) -> PyResult<Py<PyAny>>

Forcefully remove the plugin.

Removes the plugin from Docker, even if it’s currently enabled.

Returns: dict: Information about the removed plugin

Raises: SystemError: If the plugin cannot be removed

pub fn push(&self) -> PyResult<()>

Push the plugin to a registry.

Pushes the plugin to the registry specified in the plugin name.

Returns: None

Raises: SystemError: If the push fails

pub fn create(&self, path: &str) -> PyResult<()>

Create a plugin from a tar archive.

Creates a new plugin from a tar archive containing the plugin’s rootfs directory and config.json manifest.

Args: path: Path to the tar archive containing plugin rootfs and manifest

Returns: None

Raises: SystemError: If plugin creation fails

Trait Implementations

impl Debug for Pyo3Plugin

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

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for Pyo3Plugin

type Target = Pyo3Plugin

The Python output type

type Output = Bound<'py, <Pyo3Plugin as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for Pyo3Plugin

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Pyo3Plugin

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Represents an individual Docker plugin. /// /// Provides methods to inspect, enable, disable, and manage plugins.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Pyo3Plugin>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for Pyo3Plugin

const TEXT_SIGNATURE: &'static str = "(docker, name)"

impl PyMethods<Pyo3Plugin> for PyClassImplCollector<Pyo3Plugin>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Pyo3Plugin

const NAME: &'static str = "Plugin"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for Pyo3Plugin

impl ExtractPyClassWithClone for Pyo3Plugin