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