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