Trait caffe2_imports::FromPyObject

source ·

pub trait FromPyObject<'source>: Sized {
    // Required method
    fn extract(ob: &'source PyAny) -> Result<Self, PyErr>;
}

Expand description

Extract a type from a Python object.

Normal usage is through the extract methods on Py and PyAny, which forward to this trait.

Examples

use pyo3::prelude::*;
use pyo3::types::PyString;

Python::with_gil(|py| {
    let obj: Py<PyString> = PyString::new(py, "blah").into();

    // Straight from an owned reference
    let s: &str = obj.extract(py)?;

    // Or from a borrowed reference
    let obj: &PyString = obj.as_ref(py);
    let s: &str = obj.extract()?;
})

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 which case applies depends on the runtime type of the Python object, both the obj and prepared variables must outlive the resulting string slice.

The trait’s conversion method takes a &PyAny argument but is called FromPyObject for historical reasons.

Required Methods§

source

fn extract(ob: &'source PyAny) -> Result<Self, PyErr>

Extracts Self from the source PyObject.

Trait caffe2_imports::FromPyObject

Examples

Required Methods§

fn extract(ob: &'source PyAny) -> Result<Self, PyErr>

Implementations on Foreign Types§

impl<'s, T0, T1, T2, T3> FromPyObject<'s> for (T0, T1, T2, T3)where T0: FromPyObject<'s>, T1: FromPyObject<'s>, T2: FromPyObject<'s>, T3: FromPyObject<'s>,

fn extract(obj: &'s PyAny) -> Result<(T0, T1, T2, T3), PyErr>

impl<'s, T0, T1> FromPyObject<'s> for (T0, T1)where T0: FromPyObject<'s>, T1: FromPyObject<'s>,

fn extract(obj: &'s PyAny) -> Result<(T0, T1), PyErr>

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

fn extract(obj: &'source PyAny) -> Result<u32, PyErr>

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

fn extract(obj: &'source PyAny) -> Result<u8, PyErr>

impl<'s, T0, T1, T2, T3, T4, T5, T6> FromPyObject<'s> for (T0, T1, T2, T3, T4, T5, T6)where T0: FromPyObject<'s>, T1: FromPyObject<'s>, T2: FromPyObject<'s>, T3: FromPyObject<'s>, T4: FromPyObject<'s>, T5: FromPyObject<'s>, T6: FromPyObject<'s>,

fn extract(obj: &'s PyAny) -> Result<(T0, T1, T2, T3, T4, T5, T6), PyErr>

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

fn extract(obj: &'source PyAny) -> Result<bool, PyErr>

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

fn extract(obj: &'source PyAny) -> Result<i8, PyErr>

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

fn extract(obj: &'source PyAny) -> Result<u16, PyErr>

impl<'a, T, const N: usize> FromPyObject<'a> for [T; N]where T: FromPyObject<'a>,

fn extract(obj: &'a PyAny) -> Result<[T; N], PyErr>

impl<'s, T0> FromPyObject<'s> for (T0,)where T0: FromPyObject<'s>,

fn extract(obj: &'s PyAny) -> Result<(T0,), PyErr>

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

fn extract(obj: &'source PyAny) -> Result<i16, PyErr>

impl FromPyObject<'_> for OsString

fn extract(ob: &PyAny) -> Result<OsString, PyErr>

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

fn extract(obj: &'source PyAny) -> Result<i64, PyErr>

impl<'source> FromPyObject<'source> for u128

fn extract(ob: &'source PyAny) -> Result<u128, PyErr>

impl<'s, T0, T1, T2> FromPyObject<'s> for (T0, T1, T2)where T0: FromPyObject<'s>, T1: FromPyObject<'s>, T2: FromPyObject<'s>,

fn extract(obj: &'s PyAny) -> Result<(T0, T1, T2), PyErr>

impl FromPyObject<'_> for char

fn extract(obj: &PyAny) -> Result<char, PyErr>

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

fn extract(ob: &'source PyAny) -> Result<u64, PyErr>

fn extract( obj: &'s PyAny ) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7, T8), PyErr>

impl<'a> FromPyObject<'a> for &'a [u8]

fn extract(obj: &'a PyAny) -> Result<&'a [u8], PyErr>

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

fn extract(obj: &'source PyAny) -> Result<i32, PyErr>

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

fn extract(ob: &'source PyAny) -> Result<&'source str, PyErr>

impl<'s, T0, T1, T2, T3, T4, T5, T6, T7> FromPyObject<'s> for (T0, T1, T2, T3, T4, T5, T6, T7)where T0: FromPyObject<'s>, T1: FromPyObject<'s>, T2: FromPyObject<'s>, T3: FromPyObject<'s>, T4: FromPyObject<'s>, T5: FromPyObject<'s>, T6: FromPyObject<'s>, T7: FromPyObject<'s>,

fn extract(obj: &'s PyAny) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7), PyErr>

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

fn extract(obj: &'source PyAny) -> Result<f64, PyErr>

fn extract( obj: &'s PyAny ) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11), PyErr>

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

fn extract(obj: &'source PyAny) -> Result<f32, PyErr>

fn extract( obj: &'s PyAny ) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10), PyErr>

fn extract( obj: &'s PyAny ) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7, T8, T9), PyErr>

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

fn extract(obj: &'source PyAny) -> Result<isize, PyErr>

impl<'s, T0, T1, T2, T3, T4> FromPyObject<'s> for (T0, T1, T2, T3, T4)where T0: FromPyObject<'s>, T1: FromPyObject<'s>, T2: FromPyObject<'s>, T3: FromPyObject<'s>, T4: FromPyObject<'s>,

fn extract(obj: &'s PyAny) -> Result<(T0, T1, T2, T3, T4), PyErr>

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

fn extract(obj: &'a PyAny) -> Result<Vec<T, Global>, PyErr>

impl<'s, T0, T1, T2, T3, T4, T5> FromPyObject<'s> for (T0, T1, T2, T3, T4, T5)where T0: FromPyObject<'s>, T1: FromPyObject<'s>, T2: FromPyObject<'s>, T3: FromPyObject<'s>, T4: FromPyObject<'s>, T5: FromPyObject<'s>,

fn extract(obj: &'s PyAny) -> Result<(T0, T1, T2, T3, T4, T5), PyErr>

impl FromPyObject<'_> for PathBuf

fn extract(ob: &PyAny) -> Result<PathBuf, PyErr>

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

fn extract(obj: &'source PyAny) -> Result<usize, PyErr>

impl<'source> FromPyObject<'source> for i128

fn extract(ob: &'source PyAny) -> Result<i128, PyErr>

impl<'source> FromPyObject<'source> for Cow<'source, [u8]>

fn extract(ob: &'source PyAny) -> Result<Cow<'source, [u8]>, PyErr>

impl FromPyObject<'_> for String

fn extract(obj: &PyAny) -> Result<String, PyErr>

Implementors§

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

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

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

impl<'a, T> FromPyObject<'a> for Py<T>where T: PyTypeInfo, &'a <T as PyTypeInfo>::AsRefTarget: FromPyObject<'a>, <T as PyTypeInfo>::AsRefTarget: 'a + AsPyPointer,

impl<'a, T> FromPyObject<'a> for PyRef<'a, T>where T: PyClass,

impl<'a, T> FromPyObject<'a> for PyRefMut<'a, T>where T: PyClass<Frozen = False>,