Struct Pyo3Exec 

pub struct Pyo3Exec { /* private fields */ }

Represents a Docker exec instance for running commands in containers.

Use this to inspect or resize an exec session that was created with Container.exec_create().

Implementations

impl Pyo3Exec

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

Get an existing exec instance by ID.

Args: docker: Docker client instance id: Exec instance ID

Returns: Exec: Exec instance

pub fn id(&self) -> String

Get the exec instance ID.

Returns: str: Exec instance ID

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

Inspect the exec instance to get detailed information.

Returns information about the exec instance including its running state, exit code, process config, and container ID.

Returns: dict: Detailed exec information including: - id: Exec instance ID - running: Whether the exec is running - exit_code: Exit code (if completed) - process_config: Command and environment - container_id: ID of the container

Raises: SystemError: If inspect fails

pub fn resize(&self, width: u64, height: u64) -> PyResult<()>

Resize the TTY session for this exec instance.

This only works if the exec was created with tty=True. Use this to adjust terminal dimensions for interactive sessions.

Args: width: New terminal width in columns height: New terminal height in rows

Returns: None

Raises: SystemError: If resize fails (e.g., exec not created with TTY)

Trait Implementations

impl<'py> IntoPyObject<'py> for Pyo3Exec

type Target = Pyo3Exec

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Pyo3Exec

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 a Docker exec instance for running commands in containers. /// /// Use this to inspect or resize an exec session that was created with /// Container.exec_create().

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

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 Pyo3Exec

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

impl PyMethods<Pyo3Exec> for PyClassImplCollector<Pyo3Exec>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Pyo3Exec

const NAME: &'static str = "Exec"

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 Pyo3Exec

impl ExtractPyClassWithClone for Pyo3Exec