Struct PyString 

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

Represents a Python string (a Unicode string object).

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyString> or Bound<'py, PyString>.

For APIs available on str objects, see the PyStringMethods trait which is implemented for Bound<'py, PyString>.

Equality

For convenience, Bound<'py, PyString> implements PartialEq<str> to allow comparing the data in the Python string to a Rust UTF-8 string slice.

This is not always the most appropriate way to compare Python strings, as Python string subclasses may have different equality semantics. In situations where subclasses overriding equality might be relevant, use PyAnyMethods::eq, at cost of the additional overhead of a Python method call.

use pyo3::types::PyString;

let py_string = PyString::new(py, "foo");
// via PartialEq<str>
assert_eq!(py_string, "foo");

// via Python equality
assert!(py_string.as_any().eq("foo").unwrap());

Implementations

impl PyString

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

Creates a new Python string object.

Panics if out of memory.

pub fn from_bytes<'py>( py: Python<'py>, s: &[u8], ) -> PyResult<Bound<'py, PyString>>

Creates a new Python string object from bytes.

Returns PyMemoryError if out of memory. Returns PyUnicodeDecodeError if the slice is not a valid UTF-8 string.

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

Intern the given string

This will return a reference to the same Python string object if called repeatedly with the same string.

Note that while this is more memory efficient than PyString::new, it unconditionally allocates a temporary Python string object and is thereby slower than PyString::new.

Panics if out of memory.

pub fn from_encoded_object<'py>( src: &Bound<'py, PyAny>, encoding: Option<&CStr>, errors: Option<&CStr>, ) -> PyResult<Bound<'py, PyString>>

Attempts to create a Python string from a Python bytes-like object.

The encoding and errors parameters are optional:

• If encoding is None, the default encoding is used (UTF-8).
• If errors is None, the default error handling is used (“strict”).

See the Python documentation on codecs for more information.

pub fn from_object<'py>( src: &Bound<'py, PyAny>, encoding: &str, errors: &str, ) -> PyResult<Bound<'py, PyString>>

👎Deprecated since 0.25.0: replaced with to PyString::from_encoded_object

Deprecated form of PyString::from_encoded_object.

This version took &str arguments for encoding and errors, which required a runtime conversion to CString internally.

Trait Implementations

impl PyTypeInfo for PyString

const NAME: &'static str = "PyString"

👎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: TypeHint

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

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

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

Returns the safe abstraction over the type object.

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

Checks if object is an instance of this type.

impl DerefToPyAny for PyString