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