Struct Pyo3Networks 

pub struct Pyo3Networks(pub Networks);

Interface for managing Docker networks collection.

Tuple Fields

0: Networks

Implementations

impl Pyo3Networks

pub fn new(docker: Pyo3Docker) -> Self

pub fn get(&self, id: &str) -> Pyo3Network

Get a specific network by ID or name.

Args: id: Network ID or name

Returns: Network: Network instance

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

List all networks.

Returns: list[dict]: List of network information dictionaries

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

Remove unused networks.

Returns: dict: Prune results including networks deleted

pub fn create( &self, name: &str, check_duplicate: Option<bool>, driver: Option<&str>, internal: Option<bool>, attachable: Option<bool>, ingress: Option<bool>, enable_ipv6: Option<bool>, options: Option<&Bound<'_, PyDict>>, labels: Option<&Bound<'_, PyDict>>, ) -> PyResult<Pyo3Network>

Create a new network.

Args: name: Network name check_duplicate: Check for duplicate networks with the same name driver: Network driver (e.g., “bridge”, “overlay”) internal: Restrict external access to the network attachable: Enable manual container attachment ingress: Create an ingress network enable_ipv6: Enable IPv6 networking options: Driver-specific options as dict labels: Labels as dict (e.g., {“env”: “prod”})

Returns: Network: Created network instance

Trait Implementations

impl Debug for Pyo3Networks

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

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for Pyo3Networks

type Target = Pyo3Networks

The Python output type

type Output = Bound<'py, <Pyo3Networks 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 Pyo3Networks

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Pyo3Networks

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 = /// Interface for managing Docker networks collection.

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<Pyo3Networks>

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 Pyo3Networks

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

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder Pyo3Networks

type Holder = Option<PyClassGuard<'a, Pyo3Networks>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut Pyo3Networks

type Holder = Option<PyClassGuardMut<'a, Pyo3Networks>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<Pyo3Networks> for PyClassImplCollector<Pyo3Networks>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Pyo3Networks

const NAME: &'static str = "Networks"

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 Pyo3Networks