Struct pyo3::exceptions::PyStopAsyncIteration
source · pub struct PyStopAsyncIteration(/* private fields */);
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;
use pyo3::ffi::c_str;
Python::with_gil(|py| {
let result: PyResult<()> = py.run(c_str!("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");
});
Implementations§
Trait Implementations§
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§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.
source§fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
👎Deprecated since 0.23.0: renamed to
PyTypeInfo::type_object
Deprecated name for
PyTypeInfo::type_object
.source§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
Checks if
object
is an instance of this type or a subclass of this type.source§fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool
fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool
👎Deprecated since 0.23.0: renamed to
PyTypeInfo::is_type_of
Deprecated name for
PyTypeInfo::is_type_of
.source§fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
Checks if
object
is an instance of this type.source§fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool
👎Deprecated since 0.23.0: renamed to
PyTypeInfo::is_exact_type_of
Deprecated name for
PyTypeInfo::is_exact_type_of
.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> 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