Struct pyo3::types::PyString

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

Represents a Python string (a Unicode string object).

This type is immutable.

Implementations

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]>

Gets 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>>

Converts the PyString into a Rust string.

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

Converts 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<'py> FromPyObject<'py> for &'py PyString

fn extract(obj: &'py PyAny) -> PyResult<Self>

Extracts Self from the source PyObject.

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 PyLayout<PyString> for PyObject

const IS_NATIVE_TYPE: bool

fn get_super(&mut self) -> Option<&mut T::BaseLayout>

unsafe fn py_init(&mut self, _value: T)

unsafe fn py_drop(&mut self, _py: Python)

impl PyNativeType for PyString

fn py(&self) -> Python

impl PyTypeInfo for PyString

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

type Layout = PyObject

Layout

type BaseLayout = PyObject

Layout of Basetype.

type Initializer = PyNativeTypeInitializer<Self>

Initializer for layout

type AsRefTarget = Self

Utility type to make AsPyRef work

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

fn type_object() -> &'static PyTypeObject

PyTypeObject instance for this type.

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 ToPyObject for PyString

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

Converts self into a Python object.