Struct PyUnicodeDecodeError

pub struct PyUnicodeDecodeError(/* private fields */);

Available on crate features dep_pyo3 and std only.

Represents Python’s UnicodeDecodeError exception.

Implementations

impl PyUnicodeDecodeError

pub fn new_err<A>(args: A) -> PyErr

where A: PyErrArguments + Send + Sync + 'static,

Creates a new PyErr of this type.

impl PyUnicodeDecodeError

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

Creates a Python UnicodeDecodeError.

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

👎Deprecated since 0.23.0: renamed to PyUnicodeDecodeError::new

Deprecated name for PyUnicodeDecodeError::new.

pub fn new_utf8<'py>( py: Python<'py>, input: &[u8], err: Utf8Error, ) -> Result<Bound<'py, PyUnicodeDecodeError>, PyErr>

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(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(())
})

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

👎Deprecated since 0.23.0: renamed to PyUnicodeDecodeError::new_utf8

Deprecated name for PyUnicodeDecodeError::new_utf8.

Trait Implementations

impl AsRef<PyAny> for PyUnicodeDecodeError

fn as_ref(&self) -> &PyAny

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

impl Deref for PyUnicodeDecodeError

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeInfo for PyUnicodeDecodeError

const NAME: &'static str = "PyUnicodeDecodeError"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

Returns the safe abstraction over the type object.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

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

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

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PyUnicodeDecodeError

impl PyLayout<PyUnicodeDecodeError> for PyBaseExceptionObject

impl PySizedLayout<PyUnicodeDecodeError> for PyBaseExceptionObject

impl ToPyErr for PyUnicodeDecodeError