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