pyo3::types

Struct PyUnicode

Source
pub struct PyUnicode(/* private fields */);
Expand description

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_bound(py, "foo");
// via PartialEq<str>
assert_eq!(py_string, "foo");

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

Implementations§

Source§

impl PyString

Source

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

Creates a new Python string object.

Panics if out of memory.

Source

pub fn intern_bound<'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_bound, it unconditionally allocates a temporary Python string object and is thereby slower than PyString::new_bound.

Panics if out of memory.

Source

pub fn from_object_bound<'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§

Source§

impl AsPyPointer for PyString

Source§

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

Source§

impl AsRef<PyAny> for PyString

Source§

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Deref for PyString

Source§

type Target = PyAny

The resulting type after dereferencing.
Source§

fn deref(&self) -> &PyAny

Dereferences the value.
Source§

impl PyTypeInfo for PyString

Source§

const NAME: &'static str = "PyString"

Class name.
Source§

const MODULE: Option<&'static str> = _

Module name, if any.
Source§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
Source§

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

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

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

Returns the safe abstraction over the type object.
Source§

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

Checks if object is an instance of this type.
Source§

impl DerefToPyAny for PyString

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

Source§

const NAME: &'static str = const NAME: &'static str = <T as PyTypeInfo>::NAME;

Name of self. This is used in error messages, for example.
Source§

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

Checks if object is an instance of Self, which may include a subtype. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.