Enum PyStringData

pub enum PyStringData<'a> {
    Ucs1(&'a [u8]),
    Ucs2(&'a [u16]),
    Ucs4(&'a [u32]),
}

Available on crate features dep_pyo3 and std only.

Represents raw data backing a Python str.

Python internally stores strings in various representations. This enumeration represents those variations.

Variants

Ucs1(&'a [u8])

UCS1 representation.

Ucs2(&'a [u16])

UCS2 representation.

Ucs4(&'a [u32])

UCS4 representation.

Implementations

impl<'a> PyStringData<'a>

pub fn as_bytes(&self) -> &[u8]

Obtain the raw bytes backing this instance as a u8 slice.

pub fn value_width_bytes(&self) -> usize

Size in bytes of each value/item in the underlying slice.

pub fn to_string(self, py: Python<'_>) -> Result<Cow<'a, str>, PyErr>

Convert the raw data to a Rust string.

For UCS-1 / UTF-8, returns a borrow into the original slice. For UCS-2 and UCS-4, returns an owned string.

Returns PyUnicodeDecodeError if the string data isn’t valid in its purported storage format. This should only occur for strings that were created via Python C APIs that skip input validation (like PyUnicode_FromKindAndData) and should never occur for strings that were created from Python code.

pub fn to_string_lossy(self) -> Cow<'a, str>

Convert the raw data to a Rust string, possibly with data loss.

Invalid code points will be replaced with U+FFFD REPLACEMENT CHARACTER.

Returns a borrow into original data, when possible, or owned data otherwise.

The return value of this function should only disagree with Self::to_string when that method would error.

Trait Implementations

impl<'a> Clone for PyStringData<'a>

fn clone(&self) -> PyStringData<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for PyStringData<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> PartialEq for PyStringData<'a>

fn eq(&self, other: &PyStringData<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for PyStringData<'a>

impl<'a> Eq for PyStringData<'a>

impl<'a> StructuralPartialEq for PyStringData<'a>