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