Struct cpython::PyUnicode

pub struct PyUnicode(_);

Represents a Python unicode string. Corresponds to unicode in Python 2, and str in Python 3.

Implementations

impl PyUnicode

pub fn new(py: Python<'_>, s: &str) -> PyUnicode

Creates a new Python unicode string object.

Panics if out of memory.

pub fn as_basestring(&self) -> &PyString

Converts from PyUnicode to PyString. This method is only available on Python 2. (note: on Python 3, PyUnicode is a type alias for PyString)

pub fn into_basestring(self) -> PyString

Converts from PyUnicode to PyString. This method is only available on Python 2. (note: on Python 3, PyUnicode is a type alias for PyString)

pub fn data(&self, _py: Python<'_>) -> PyStringData<'_>

Gets the python string data in its underlying representation.

pub fn to_string(&self, py: Python<'_>) -> PyResult<Cow<'_, str>>

Convert the PyUnicode into a Rust string.

Returns a UnicodeDecodeError if the input is not valid unicode (containing unpaired surrogates).

pub fn to_string_lossy(&self, py: Python<'_>) -> Cow<'_, str>

Convert the PyUnicode into a Rust string.

Unpaired surrogates are replaced with U+FFFD REPLACEMENT CHARACTER.

Trait Implementations

impl<'s> FromPyObject<'s> for PyUnicode

fn extract(py: Python<'_>, obj: &'s PyObject) -> PyResult<PyUnicode>

Extracts Self from the source PyObject.

impl<'s> FromPyObject<'s> for &'s PyUnicode

fn extract(py: Python<'_>, obj: &'s PyObject) -> PyResult<&'s PyUnicode>

Extracts Self from the source PyObject.

impl PythonObject for PyUnicode

fn as_object(&self) -> &PyObject

Casts the Python object to PyObject.

fn into_object(self) -> PyObject

Casts the Python object to PyObject.

unsafe fn unchecked_downcast_from(obj: PyObject) -> Self

Unchecked downcast from PyObject to Self. Undefined behavior if the input object does not have the expected type.

unsafe fn unchecked_downcast_borrow_from<'a>(obj: &'a PyObject) -> &'a Self

Unchecked downcast from PyObject to Self. Undefined behavior if the input object does not have the expected type.

impl PythonObjectWithCheckedDowncast for PyUnicode

fn downcast_from<'p>(
    py: Python<'p>,
    obj: PyObject
) -> Result<PyUnicode, PythonObjectDowncastError<'p>>

Cast from PyObject to a concrete Python object type.

fn downcast_borrow_from<'a, 'p>(
    py: Python<'p>,
    obj: &'a PyObject
) -> Result<&'a PyUnicode, PythonObjectDowncastError<'p>>

Cast from PyObject to a concrete Python object type.

impl PythonObjectWithTypeObject for PyUnicode

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

Retrieves the type object for this Python object type.

impl ToPyObject for PyUnicode

Identity conversion: allows using existing PyObject instances where T: ToPyObject is expected.

type ObjectType = PyUnicode

fn to_py_object(&self, py: Python<'_>) -> PyUnicode

Converts self into a Python object.

fn into_py_object(self, _py: Python<'_>) -> PyUnicode

Converts self into a Python object.

fn with_borrowed_ptr<F, R>(&self, _py: Python<'_>, f: F) -> R where
    F: FnOnce(*mut PyObject) -> R, 

Converts self into a Python object and calls the specified closure on the native FFI pointer underlying the Python object.