Struct pyo3::PyString
[−]
[src]
pub struct PyString(_);
Represents a Python string
.
Methods
impl PyString
[src]
pub fn new(_py: Python, s: &str) -> Py<PyString>
[src]
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>
[src]
src: &'p PyObjectRef,
encoding: &str,
errors: &str
) -> PyResult<&'p PyString>
pub fn data(&self) -> PyStringData
[src]
Gets the python string data in its underlying representation.
pub fn to_string(&self) -> PyResult<Cow<str>>
[src]
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>
[src]
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
[src]
impl AsRef<PyObjectRef> for PyString
[src]
fn as_ref(&self) -> &PyObjectRef
[src]
Performs the conversion.
impl PyObjectWithToken for PyString
[src]
impl ToPyPointer for PyString
[src]
impl PartialEq for PyString
[src]
fn eq(&self, o: &PyString) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl PyTypeInfo for PyString
[src]
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
[src]
PyTypeObject instance for this type
fn is_instance(ptr: *mut PyObject) -> bool
[src]
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
[src]
Check if *mut ffi::PyObject
is exact instance of this type
impl PyTypeObject for PyString
[src]
fn init_type()
[src]
Initialize type object
fn type_object() -> Py<PyType>
[src]
Retrieves the type object for this Python object type.
fn create(py: Python) -> PyResult<PyRawObject> where
Self: Sized + PyObjectAlloc<Self> + PyTypeInfo,
[src]
Self: Sized + PyObjectAlloc<Self> + PyTypeInfo,
Create PyRawObject which can be initialized with rust value
impl ToPyObject for PyString
[src]
impl ToBorrowedObject for PyString
[src]
fn with_borrowed_ptr<F, R>(&self, _py: Python, f: F) -> R where
F: FnOnce(*mut PyObject) -> R,
[src]
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. Read more
impl Debug for PyString
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter. Read more
impl Display for PyString
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter. Read more
impl<'a> FromPyObject<'a> for &'a PyString
[src]
fn extract(ob: &'a PyObjectRef) -> PyResult<Self>
[src]
Extracts Self
from the source PyObject
.