Struct pyo3::exceptions::PyUnicodeDecodeError

source ·
pub struct PyUnicodeDecodeError(/* private fields */);
Expand description

Represents Python’s UnicodeDecodeError exception.

Implementations§

source§

impl PyUnicodeDecodeError

source

pub fn new_err<A>(args: A) -> PyErr
where A: PyErrArguments + Send + Sync + 'static,

Creates a new PyErr of this type.

source§

impl PyUnicodeDecodeError

source

pub fn new_bound<'p>( py: Python<'p>, encoding: &CStr, input: &[u8], range: Range<usize>, reason: &CStr ) -> PyResult<Bound<'p, PyUnicodeDecodeError>>

Creates a Python UnicodeDecodeError.

source

pub fn new_utf8_bound<'p>( py: Python<'p>, input: &[u8], err: Utf8Error ) -> PyResult<Bound<'p, PyUnicodeDecodeError>>

Creates a Python UnicodeDecodeError from a Rust UTF-8 decoding error.

§Examples
#![cfg_attr(invalid_from_utf8_lint, allow(invalid_from_utf8))]
use pyo3::prelude::*;
use pyo3::exceptions::PyUnicodeDecodeError;

Python::with_gil(|py| {
    let invalid_utf8 = b"fo\xd8o";
    let err = std::str::from_utf8(invalid_utf8).expect_err("should be invalid utf8");
    let decode_err = PyUnicodeDecodeError::new_utf8_bound(py, invalid_utf8, err)?;
    assert_eq!(
        decode_err.to_string(),
        "'utf-8' codec can't decode byte 0xd8 in position 2: invalid utf-8"
    );
    Ok(())
})

Trait Implementations§

source§

impl AsPyPointer for PyUnicodeDecodeError

source§

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

source§

impl AsRef<PyAny> for PyUnicodeDecodeError

source§

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Deref for PyUnicodeDecodeError

§

type Target = PyAny

The resulting type after dereferencing.
source§

fn deref(&self) -> &PyAny

Dereferences the value.
source§

impl PyTypeInfo for PyUnicodeDecodeError

source§

const NAME: &'static str = "PyUnicodeDecodeError"

Class name.
source§

const MODULE: Option<&'static str> = _

Module name, if any.
source§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
source§

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.
source§

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.
source§

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.
source§

impl DerefToPyAny for PyUnicodeDecodeError

source§

impl PyLayout<PyUnicodeDecodeError> for PyBaseExceptionObject

source§

impl PySizedLayout<PyUnicodeDecodeError> for PyBaseExceptionObject

source§

impl ToPyErr for PyUnicodeDecodeError

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

source§

const NAME: &'static str = const NAME: &'static str = <T as PyTypeInfo>::NAME;

Name of self. This is used in error messages, for example.
source§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.