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