Struct cpython::PyString

pub struct PyString(_);

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

Implementations

impl PyString

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

Creates a new Python string object.

On Python 2.7, this function will create a byte string if the feature py2-no-auto-unicode-promotion is set, or the input input string is ASCII-only; otherwise, the input string will be converted to a unicode string. Use PyUnicode::new() to always create a unicode string.

On Python 3.x, this function always creates unicode str objects.

Panics if out of memory.

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

Gets the python string data in its underlying representation.

For Python 2 byte strings, this function always returns PyStringData::Utf8, even if the bytes are not valid UTF-8. For unicode strings, returns the underlying representation used by Python.

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

Convert the PyString into a Rust string.

On Python 2.7, if the PyString refers to a byte string, it will be decoded using UTF-8.

Returns a UnicodeDecodeError if the input is not valid unicode (containing unpaired surrogates, or a Python 2.7 byte string that is not valid UTF-8).

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

Convert the PyString into a Rust string.

On Python 2.7, if the PyString refers to a byte string, it will be decoded using UTF-8.

Unpaired surrogates and (on Python 2.7) invalid UTF-8 sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

Trait Implementations

impl<'s> FromPyObject<'s> for PyString

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

Extracts Self from the source PyObject.

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

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

Extracts Self from the source PyObject.

impl PythonObject for PyString

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 PyString

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

Cast from PyObject to a concrete Python object type.

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

Cast from PyObject to a concrete Python object type.

impl PythonObjectWithTypeObject for PyString

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

Retrieves the type object for this Python object type.

impl ToPyObject for PyString

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

type ObjectType = PyString

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

Converts self into a Python object.

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

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.