Struct pyo3::exceptions::PyReferenceError

source ·
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;

Python::with_gil(|py| {
    let result: PyResult<()> = py.run_bound("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§

source§

impl PyReferenceError

source

pub fn new_err<A>(args: A) -> PyErr
where A: PyErrArguments + Send + Sync + 'static,

Creates a new PyErr of this type.

Trait Implementations§

source§

impl AsPyPointer for PyReferenceError

source§

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

source§

impl AsRef<PyAny> for PyReferenceError

source§

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Deref for PyReferenceError

§

type Target = PyAny

The resulting type after dereferencing.
source§

fn deref(&self) -> &PyAny

Dereferences the value.
source§

impl PyTypeInfo for PyReferenceError

source§

const NAME: &'static str = "PyReferenceError"

Class name.
source§

const MODULE: Option<&'static str> = _

Module name, if any.
source§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
source§

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.
source§

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.
source§

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.
source§

impl DerefToPyAny for PyReferenceError

source§

impl PyLayout<PyReferenceError> for PyBaseExceptionObject

source§

impl PySizedLayout<PyReferenceError> for PyBaseExceptionObject

source§

impl ToPyErr for PyReferenceError

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

source§

const NAME: &'static str = const NAME: &'static str = <T as PyTypeInfo>::NAME;

Name of self. This is used in error messages, for example.
source§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.