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