Struct PyString

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

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());

Tuple Fields

0: PyAny

Implementations

impl PyString

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self>

#[doc(hidden)] pub const _PYO3_INTROSPECTION_ID: &'static str = ":: std :: option :: Option :: Some(\"builtins\")PyString"

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 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_object<'py>( src: &Bound<'py, PyAny>, encoding: &str, errors: &str, ) -> PyResult<Bound<'py, PyString>>

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

Trait Implementations

impl PyTypeInfo for PyString

const NAME: &'static str = "PyString"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

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