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