Trait pyo3::prelude::FromPyObject
[−]
[src]
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 obj: PyObject = ...; 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,
[src]
T: PyTypeInfo,
Extract reference to instance from PyObject
fn extract(ob: &'a PyObjectRef) -> PyResult<&'a T>
[src]
impl<'source, T> FromPyObject<'source> for Option<T> where
T: FromPyObject<'source>,
[src]
T: FromPyObject<'source>,
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for bool
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'s, A: FromPyObject<'s>> FromPyObject<'s> for (A,)
[src]
fn extract(obj: &'s PyObjectRef) -> PyResult<Self>
[src]
impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>> FromPyObject<'s> for (A, B)
[src]
fn extract(obj: &'s PyObjectRef) -> PyResult<Self>
[src]
impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>, C: FromPyObject<'s>> FromPyObject<'s> for (A, B, C)
[src]
fn extract(obj: &'s PyObjectRef) -> PyResult<Self>
[src]
impl<'s, A: FromPyObject<'s>, B: FromPyObject<'s>, C: FromPyObject<'s>, D: FromPyObject<'s>> FromPyObject<'s> for (A, B, C, D)
[src]
fn extract(obj: &'s PyObjectRef) -> PyResult<Self>
[src]
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)
[src]
fn extract(obj: &'s PyObjectRef) -> PyResult<Self>
[src]
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)
[src]
fn extract(obj: &'s PyObjectRef) -> PyResult<Self>
[src]
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)
[src]
fn extract(obj: &'s PyObjectRef) -> PyResult<Self>
[src]
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)
[src]
fn extract(obj: &'s PyObjectRef) -> PyResult<Self>
[src]
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)
[src]
fn extract(obj: &'s PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for f64
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for f32
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'a, T> FromPyObject<'a> for Vec<T> where
T: FromPyObject<'a>,
[src]
T: FromPyObject<'a>,
fn extract(obj: &'a PyObjectRef) -> PyResult<Self>
[src]
impl<'source, T> FromPyObject<'source> for Vec<T> where
T: FromPyObject<'a> + Element + Copy,
[src]
T: FromPyObject<'a> + Element + Copy,
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for Cow<'source, str>
[src]
Allows extracting strings from Python objects.
Accepts Python str
and unicode
objects.
fn extract(ob: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for String
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for i8
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for u8
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for i16
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for u16
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for i32
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for u32
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for i64
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for isize
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for usize
[src]
fn extract(obj: &'source PyObjectRef) -> PyResult<Self>
[src]
impl<'source> FromPyObject<'source> for u64
[src]
fn extract(ob: &'source PyObjectRef) -> PyResult<u64>
[src]
Implementors
impl<'a, T> FromPyObject<'a> for Py<T> where
T: ToPyPointer + 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