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