pub struct Pyo3Volumes(pub Volumes);Expand description
Interface for managing Docker volumes collection.
Tuple Fields§
§0: VolumesImplementations§
Source§impl Pyo3Volumes
impl Pyo3Volumes
pub fn new(docker: Pyo3Docker) -> Self
Sourcepub fn get(&self, name: &str) -> Pyo3Volume
pub fn get(&self, name: &str) -> Pyo3Volume
Get a specific volume by name.
Args: name: Volume name
Returns: Volume: Volume instance
Sourcepub fn prune(&self) -> PyResult<Py<PyAny>>
pub fn prune(&self) -> PyResult<Py<PyAny>>
Remove unused volumes.
Returns: dict: Prune results including volumes deleted and space reclaimed
Sourcepub fn list(&self) -> PyResult<Py<PyAny>>
pub fn list(&self) -> PyResult<Py<PyAny>>
List all volumes.
Returns: dict: Volume list information
Sourcepub fn create(
&self,
name: Option<&str>,
driver: Option<&str>,
driver_opts: Option<&Bound<'_, PyDict>>,
labels: Option<&Bound<'_, PyDict>>,
) -> PyResult<Py<PyAny>>
pub fn create( &self, name: Option<&str>, driver: Option<&str>, driver_opts: Option<&Bound<'_, PyDict>>, labels: Option<&Bound<'_, PyDict>>, ) -> PyResult<Py<PyAny>>
Create a new volume.
Args: name: Volume name driver: Volume driver (e.g., “local”) driver_opts: Driver-specific options as dict labels: Labels as dict (e.g., {“env”: “prod”})
Returns: dict: Created volume information
Trait Implementations§
Source§impl Debug for Pyo3Volumes
impl Debug for Pyo3Volumes
Source§impl<'py> IntoPyObject<'py> for Pyo3Volumes
impl<'py> IntoPyObject<'py> for Pyo3Volumes
Source§type Target = Pyo3Volumes
type Target = Pyo3Volumes
The Python output type
Source§type Output = Bound<'py, <Pyo3Volumes as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <Pyo3Volumes as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClass for Pyo3Volumes
impl PyClass for Pyo3Volumes
Source§impl PyClassImpl for Pyo3Volumes
impl PyClassImpl for Pyo3Volumes
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// Interface for managing Docker volumes collection.
const RAW_DOC: &'static CStr = /// Interface for managing Docker volumes collection.
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<Pyo3Volumes>
type ThreadChecker = SendablePyClass<Pyo3Volumes>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
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>
Source§impl PyClassNewTextSignature for Pyo3Volumes
impl PyClassNewTextSignature for Pyo3Volumes
const TEXT_SIGNATURE: &'static str = "(docker)"
Source§impl PyMethods<Pyo3Volumes> for PyClassImplCollector<Pyo3Volumes>
impl PyMethods<Pyo3Volumes> for PyClassImplCollector<Pyo3Volumes>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for Pyo3Volumes
impl PyTypeInfo for Pyo3Volumes
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
impl DerefToPyAny for Pyo3Volumes
impl ExtractPyClassWithClone for Pyo3Volumes
Auto Trait Implementations§
impl Freeze for Pyo3Volumes
impl !RefUnwindSafe for Pyo3Volumes
impl Send for Pyo3Volumes
impl Sync for Pyo3Volumes
impl Unpin for Pyo3Volumes
impl !UnwindSafe for Pyo3Volumes
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information.Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.