Struct PyUnicodeDecodeError 

#[repr(transparent)]
pub struct PyUnicodeDecodeError(PyAny);

Represents Python’s UnicodeDecodeError exception.

Tuple Fields

0: PyAny

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

#[doc(hidden)]

pub const _PYO3_DEF: AddTypeToModule<Self>

#[doc(hidden)]

pub const _PYO3_INTROSPECTION_ID: &'static str = ":: std :: option :: Option :: Some(\"builtins\")PyUnicodeDecodeError"

impl PyUnicodeDecodeError

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

Creates a Python UnicodeDecodeError.

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

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

Examples

use pyo3::prelude::*;
use pyo3::exceptions::PyUnicodeDecodeError;

Python::attach(|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_err_from_utf8(py: Python<'_>, bytes: &[u8], err: Utf8Error) -> PyErr

Create a new PyErr of this type from a Rust UTF-8 decoding error.

This is equivalent to PyUnicodeDecodeError::new_utf8, but returning a PyErr instead of an exception object.

Example

use pyo3::prelude::*;
use pyo3::exceptions::PyUnicodeDecodeError;

Python::attach(|py| {
    let invalid_utf8 = b"fo\xd8o";
    let err = std::str::from_utf8(invalid_utf8).expect_err("should be invalid utf8");
    let py_err = PyUnicodeDecodeError::new_err_from_utf8(py, invalid_utf8, err);
})

Trait Implementations

impl PyClassBaseType for PyUnicodeDecodeError

Available on non-Py_LIMITED_API only.

type LayoutAsBase = PyClassObjectBase<PyBaseExceptionObject>

type BaseNativeType = PyUnicodeDecodeError

type Initializer = PyNativeTypeInitializer<PyUnicodeDecodeError>

type PyClassMutability = ImmutableClass

type Layout<T: PyClassImpl> = PyStaticClassObject<T>

The type of object layout to use for ancestors or descendants of this type.

impl PyTypeInfo for PyUnicodeDecodeError

const NAME: &'static str = "PyUnicodeDecodeError"

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&'static str>

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

const TYPE_HINT: PyStaticExpr

Available on crate feature experimental-inspect only.

Provides the full python type as a type hint.

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 is_type_of(object: &Bound<'_, PyAny>) -> bool

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

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

Checks if object is an instance of this type.

impl DerefToPyAny for PyUnicodeDecodeError

impl PyLayout<PyUnicodeDecodeError> for PyBaseExceptionObject

impl PySizedLayout<PyUnicodeDecodeError> for PyBaseExceptionObject

impl ToPyErr for PyUnicodeDecodeError