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