Trait pyo3::FromPyObject

pub trait FromPyObject<'source>: Sized {
    fn extract(ob: &'source PyObjectRef) -> PyResult<Self>;
}

FromPyObject is implemented by various types that can be extracted from a Python object reference.

Normal usage is through the PyObject::extract helper method:

let value: &TargetType = obj.extract(py)?;

Note: depending on the implementation, the lifetime of the extracted result may depend on the lifetime of the obj or the prepared variable.

For example, when extracting &str from a python byte string, the resulting string slice will point to the existing string data (lifetime: 'source). On the other hand, when extracting &str from a python unicode string, the preparation step will convert the string to UTF-8, and the resulting string slice will have lifetime 'prepared. Since only which of these cases applies depends on the runtime type of the python object, both the obj and prepared variables must outlive the resulting string slice.

In cases where the result does not depend on the 'prepared lifetime, the inherent method PyObject::extract() can be used.

Required Methods

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

Extracts Self from the source PyObject.

Implementations on Foreign Types

impl<'a, T> FromPyObject<'a> for &'a T where     T: PyTypeInfo,

Extract reference to instance from PyObject

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

impl<'a, T> FromPyObject<'a> for &'a mut T where     T: PyTypeInfo,

Extract mutable reference to instance from PyObject

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

impl<'a, T> FromPyObject<'a> for Option<T> where     T: FromPyObject<'a>,

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

impl<'source> FromPyObject<'source> for bool

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'s, A: FromPyObject<'s>> FromPyObject<'s> for (A,)

fn extract(obj: &'s PyObjectRef) -> PyResult<Self>

impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>> FromPyObject<'s> for (A, B)

fn extract(obj: &'s PyObjectRef) -> PyResult<Self>

impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>, C: FromPyObject<'s>> FromPyObject<'s> for (A, B, C)

fn extract(obj: &'s PyObjectRef) -> PyResult<Self>

impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>, C: FromPyObject<'s>, D: FromPyObject<'s>> FromPyObject<'s> for (A, B, C, D)

fn extract(obj: &'s PyObjectRef) -> PyResult<Self>

impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>, C: FromPyObject<'s>, D: FromPyObject<'s>, E: FromPyObject<'s>> FromPyObject<'s> for (A, B, C, D, E)

fn extract(obj: &'s PyObjectRef) -> PyResult<Self>

impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>, C: FromPyObject<'s>, D: FromPyObject<'s>, E: FromPyObject<'s>, F: FromPyObject<'s>> FromPyObject<'s> for (A, B, C, D, E, F)

fn extract(obj: &'s PyObjectRef) -> PyResult<Self>

impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>, C: FromPyObject<'s>, D: FromPyObject<'s>, E: FromPyObject<'s>, F: FromPyObject<'s>, G: FromPyObject<'s>> FromPyObject<'s> for (A, B, C, D, E, F, G)

fn extract(obj: &'s PyObjectRef) -> PyResult<Self>

impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>, C: FromPyObject<'s>, D: FromPyObject<'s>, E: FromPyObject<'s>, F: FromPyObject<'s>, G: FromPyObject<'s>, H: FromPyObject<'s>> FromPyObject<'s> for (A, B, C, D, E, F, G, H)

fn extract(obj: &'s PyObjectRef) -> PyResult<Self>

impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>, C: FromPyObject<'s>, D: FromPyObject<'s>, E: FromPyObject<'s>, F: FromPyObject<'s>, G: FromPyObject<'s>, H: FromPyObject<'s>, I: FromPyObject<'s>> FromPyObject<'s> for (A, B, C, D, E, F, G, H, I)

fn extract(obj: &'s PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for f64

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for f32

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'a, T> FromPyObject<'a> for Vec<T> where     T: FromPyObject<'a>,

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

impl<'source, T> FromPyObject<'source> for Vec<T> where     T: FromPyObject<'a> + Element + Copy,

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for Cow<'source, str>

Allows extracting strings from Python objects. Accepts Python str and unicode objects.

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

impl<'a> FromPyObject<'a> for &'a str

Allows extracting strings from Python objects. Accepts Python str and unicode objects.

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

impl<'source> FromPyObject<'source> for String

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for i8

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for u8

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for i16

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for u16

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for i32

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for u32

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for i64

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for isize

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for usize

fn extract(obj: &'source PyObjectRef) -> PyResult<Self>

impl<'source> FromPyObject<'source> for u64

fn extract(ob: &'source PyObjectRef) -> PyResult<u64>

Implementors

• impl<'a, T> FromPyObject<'a> for Py<T> where     T: ToPyPointer,     &'a T: 'a + FromPyObject<'a>,

• impl<'a> FromPyObject<'a> for PyObject

• impl<'a> FromPyObject<'a> for &'a PyType

• impl<'a> FromPyObject<'a> for &'a PyModule

• impl<'a> FromPyObject<'a> for &'a PyDict

• impl<'a> FromPyObject<'a> for &'a PyBool

• impl<'a> FromPyObject<'a> for &'a PyByteArray

• impl<'a> FromPyObject<'a> for &'a PyTuple

• impl<'a> FromPyObject<'a> for &'a PyList

• impl<'a> FromPyObject<'a> for &'a PyFloat

• impl<'a> FromPyObject<'a> for &'a PySequence

• impl<'a> FromPyObject<'a> for &'a PySlice

• impl<'a> FromPyObject<'a> for &'a PySet

• impl<'a> FromPyObject<'a> for &'a PyFrozenSet

• impl<'a> FromPyObject<'a> for &'a PyLong

• impl<'a> FromPyObject<'a> for &'a PyString

• impl<'a> FromPyObject<'a> for &'a PyBytes

• impl<'a> FromPyObject<'a> for &'a PyObjectRef