Struct pyo3::exceptions::PyGeneratorExit
source · pub struct PyGeneratorExit(PyAny);
Expand description
Represents Python’s GeneratorExit
exception.
§Example: Raising GeneratorExit 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::PyGeneratorExit;
#[pyfunction]
fn always_throws() -> PyResult<()> {
let message = "I'm GeneratorExit, and I was raised from Rust.";
Err(PyGeneratorExit::new_err(message))
}
Python code:
from my_module import always_throws
try:
always_throws()
except GeneratorExit as e:
print(f"Caught an exception: {e}")
§Example: Catching GeneratorExit in Rust
use pyo3::prelude::*;
use pyo3::exceptions::PyGeneratorExit;
Python::with_gil(|py| {
let result: PyResult<()> = py.run_bound("raise GeneratorExit", None, None);
let error_type = match result {
Ok(_) => "Not an error",
Err(error) if error.is_instance_of::<PyGeneratorExit>(py) => "GeneratorExit",
Err(_) => "Some other error",
};
assert_eq!(error_type, "GeneratorExit");
});
Tuple Fields§
§0: PyAny
Implementations§
source§impl PyGeneratorExit
impl PyGeneratorExit
#[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 PyGeneratorExit
impl AsPyPointer for PyGeneratorExit
source§impl AsRef<PyAny> for PyGeneratorExit
impl AsRef<PyAny> for PyGeneratorExit
source§impl Deref for PyGeneratorExit
impl Deref for PyGeneratorExit
source§impl PyClassBaseType for PyGeneratorExit
impl PyClassBaseType for PyGeneratorExit
source§impl PyTypeInfo for PyGeneratorExit
impl PyTypeInfo for PyGeneratorExit
source§const NAME: &'static str = "PyGeneratorExit"
const NAME: &'static str = "PyGeneratorExit"
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 PyGeneratorExit
impl PyLayout<PyGeneratorExit> for PyBaseExceptionObject
impl PySizedLayout<PyGeneratorExit> for PyBaseExceptionObject
impl ToPyErr for PyGeneratorExit
Auto Trait Implementations§
impl !Freeze for PyGeneratorExit
impl !RefUnwindSafe for PyGeneratorExit
impl !Send for PyGeneratorExit
impl !Sync for PyGeneratorExit
impl Unpin for PyGeneratorExit
impl UnwindSafe for PyGeneratorExit
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