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