Struct Pyo3Network 

pub struct Pyo3Network(pub Network);

Represents an individual Docker network.

Tuple Fields

0: Network

Implementations

impl Pyo3Network

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

pub fn id(&self) -> String

Get the network ID.

Returns: str: Network ID

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

Inspect the network to get detailed information.

Returns: dict: Detailed network information including config, containers, etc.

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

Delete the network.

Returns: None

pub fn connect( &self, container_id: &str, aliases: Option<&Bound<'_, PyList>>, links: Option<&Bound<'_, PyList>>, network_id: Option<&str>, endpoint_id: Option<&str>, gateway: Option<&str>, ipv4: Option<&str>, prefix_len: Option<isize>, ipv6_gateway: Option<&str>, ipv6: Option<&str>, ipv6_prefix_len: Option<i64>, mac: Option<&str>, driver_opts: Option<&Bound<'_, PyDict>>, ipam_config: Option<&Bound<'_, PyDict>>, ) -> PyResult<()>

Connect a container to this network.

Args: container_id: Container ID or name to connect aliases: Network aliases for the container as list links: Links to other containers as list network_id: Network ID endpoint_id: Endpoint ID gateway: IPv4 gateway address ipv4: IPv4 address for the container prefix_len: IPv4 prefix length ipv6_gateway: IPv6 gateway address ipv6: IPv6 address for the container ipv6_prefix_len: IPv6 prefix length mac: MAC address driver_opts: Driver-specific options as dict ipam_config: IPAM configuration as dict with ipv4, ipv6, link_local_ips

Returns: None

pub fn disconnect( &self, container_id: &str, force: Option<bool>, ) -> PyResult<()>

Disconnect a container from this network.

Args: container_id: Container ID or name to disconnect force: Force disconnect even if container is running

Returns: None

Trait Implementations

impl Debug for Pyo3Network

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

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for Pyo3Network

type Target = Pyo3Network

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Pyo3Network

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 network.

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

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 Pyo3Network

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

impl PyMethods<Pyo3Network> for PyClassImplCollector<Pyo3Network>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Pyo3Network

const NAME: &'static str = "Network"

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 Pyo3Network

impl ExtractPyClassWithClone for Pyo3Network