Struct pyo3::exceptions::PyInterruptedError
source · pub struct PyInterruptedError(PyAny);
Expand description
Represents Python’s InterruptedError
exception.
§Example: Raising InterruptedError from Rust
This exception can be sent to Python code by converting it into a
PyErr
, where Python code can then catch it.
use pyo3::prelude::*;
use pyo3::exceptions::PyInterruptedError;
#[pyfunction]
fn always_throws() -> PyResult<()> {
let message = "I'm InterruptedError, and I was raised from Rust.";
Err(PyInterruptedError::new_err(message))
}
Python code:
from my_module import always_throws
try:
always_throws()
except InterruptedError as e:
print(f"Caught an exception: {e}")
§Example: Catching InterruptedError in Rust
use pyo3::prelude::*;
use pyo3::exceptions::PyInterruptedError;
Python::with_gil(|py| {
let result: PyResult<()> = py.run_bound("raise InterruptedError", None, None);
let error_type = match result {
Ok(_) => "Not an error",
Err(error) if error.is_instance_of::<PyInterruptedError>(py) => "InterruptedError",
Err(_) => "Some other error",
};
assert_eq!(error_type, "InterruptedError");
});
Tuple Fields§
§0: PyAny
Implementations§
source§impl PyInterruptedError
impl PyInterruptedError
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _
Methods from Deref<Target = PyAny>§
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _
Trait Implementations§
source§impl AsPyPointer for PyInterruptedError
impl AsPyPointer for PyInterruptedError
source§impl AsRef<PyAny> for PyInterruptedError
impl AsRef<PyAny> for PyInterruptedError
source§impl Deref for PyInterruptedError
impl Deref for PyInterruptedError
source§impl PyClassBaseType for PyInterruptedError
impl PyClassBaseType for PyInterruptedError
source§impl PyTypeInfo for PyInterruptedError
impl PyTypeInfo for PyInterruptedError
source§const NAME: &'static str = "PyInterruptedError"
const NAME: &'static str = "PyInterruptedError"
Available on non-crate feature
gil-refs
only.Class name.
source§const MODULE: Option<&'static str> = _
const MODULE: Option<&'static str> = _
Available on non-crate feature
gil-refs
only.Module name, if any.
source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Available on non-crate feature
gil-refs
only.Returns the PyTypeObject instance for this type.
source§fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
Available on non-crate feature
gil-refs
only.Returns the safe abstraction over the type object.
impl DerefToPyAny for PyInterruptedError
impl PyLayout<PyInterruptedError> for PyBaseExceptionObject
impl PySizedLayout<PyInterruptedError> for PyBaseExceptionObject
impl ToPyErr for PyInterruptedError
Auto Trait Implementations§
impl !Freeze for PyInterruptedError
impl !RefUnwindSafe for PyInterruptedError
impl !Send for PyInterruptedError
impl !Sync for PyInterruptedError
impl Unpin for PyInterruptedError
impl UnwindSafe for PyInterruptedError
Blanket Implementations§
source§impl<T> AssertNotZeroSized for T
impl<T> AssertNotZeroSized for T
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> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more