Struct pyo3::types::PyString

#[repr(transparent)]
pub struct PyString(_, _);

Represents a Python string.

This type is immutable

Methods

impl PyString

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

Creates a new Python string object.

Panics if out of memory.

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

pub fn as_bytes(&self) -> PyResult<&[u8]>

Get the Python string as a byte slice.

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

pub fn to_string(&self) -> PyResult<Cow<str>>

Convert the PyString into a Rust string.

pub fn to_string_lossy(&self) -> Cow<str>

Convert the PyString into a Rust string.

Unpaired surrogates invalid UTF-8 sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

Trait Implementations

impl AsPyPointer for PyString

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyString

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Debug for PyString

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for PyString

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> From<&'a PyString> for &'a PyAny

fn from(ob: &'a PyString) -> Self

Performs the conversion.

impl PartialEq<PyString> for PyString

fn eq(&self, o: &PyString) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PyNativeType for PyString

fn py(&self) -> Python

impl PyObjectAlloc for PyString

unsafe fn alloc(_py: Python) -> *mut PyObject

unsafe fn dealloc(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object and frees the memory (usually by calling ptr->ob_type->tp_free). This function is used as tp_dealloc implementation.

unsafe fn drop(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object.

impl PyTypeInfo for PyString

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

const SIZE: usize

Size of the rust PyObject structure (PyObject + rust structure)

const OFFSET: isize

Type instance offset inside PyObject structure

unsafe fn type_object() -> &'static mut PyTypeObject

PyTypeObject instance for this type, which might still need to be initialized

fn is_instance(ptr: &PyAny) -> bool

Check if *mut ffi::PyObject is instance of this type

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(object: &PyAny) -> bool

Check if *mut ffi::PyObject is exact instance of this type

impl PyTypeObject for PyString

fn init_type() -> NonNull<PyTypeObject>

This function must make sure that the corresponding type object gets initialized exactly once and return it.

fn type_object() -> Py<PyType>

Returns the safe abstraction over the type object from PyTypeObject::init_type

impl ToPyObject for PyString

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.