Struct pyo3::PyString

pub struct PyString(_);

Represents a Python string.

Methods

impl PyString

pub fn new(_py: Python, s: &str) -> Py<PyString>

Creates a new Python string object.

Panics if out of memory.

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

pub fn data(&self) -> PyStringData

Gets the python string data in its underlying representation.

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

Convert the PyString into a Rust string.

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

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<'a> From<&'a PyString> for &'a PyObjectRef

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

Performs the conversion.

impl AsRef<PyObjectRef> for PyString

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl PyObjectWithToken for PyString

fn py(&self) -> Python

impl ToPyPointer for PyString

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl PartialEq for PyString

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PyTypeInfo for PyString

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyObjectRef

Base class

const NAME: &'static str

NAME: &'static str = "PyString"

Class name

const SIZE: usize

SIZE: usize = ::std::mem::size_of::<::ffi::PyObject>()

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

const OFFSET: isize

OFFSET: isize = 0

Type instance offset inside PyObject structure

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

PyTypeObject instance for this type

fn is_instance(ptr: *mut PyObject) -> bool

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

const DESCRIPTION: &'static str

DESCRIPTION: &'static str = "\u{0}"

Class doc string

const FLAGS: usize

FLAGS: usize = 0

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(ptr: *mut PyObject) -> bool

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

impl PyTypeObject for PyString

fn init_type()

Initialize type object

fn type_object() -> Py<PyType>

Retrieves the type object for this Python object type.

fn create(py: Python) -> PyResult<PyRawObject> where
    Self: Sized + PyObjectAlloc<Self> + PyTypeInfo, 

Create PyRawObject which can be initialized with rust value

impl ToPyObject for PyString

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

Converts self into a Python object.

impl ToBorrowedObject for PyString

fn with_borrowed_ptr<F, R>(&self, _py: Python, f: F) -> R where
    F: FnOnce(*mut PyObject) -> R, 

Converts self into a Python object and calls the specified closure on the native FFI pointer underlying the Python object.

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

fn extract(ob: &'a PyObjectRef) -> PyResult<Self>

Extracts Self from the source PyObject.