Trait cpython::FromPyObject

pub trait FromPyObject<'source>: Sized {
    fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>;
}

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

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

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

TODO: update this documentation 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(py: Python, obj: &'source PyObject) -> PyResult<Self>

Extracts Self from the source PyObject.

Loading content...

Implementations on Foreign Types

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

Allows extracting strings from Python objects. Accepts Python str and unicode objects. In Python 2.7, str is expected to be UTF-8 encoded.

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

Allows extracting strings from Python objects. Accepts Python str and unicode objects. In Python 2.7, str is expected to be UTF-8 encoded.

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

Allows extracting byte arrays from Python objects. For Python bytes, returns a reference to the existing immutable string data. For other types, converts to an owned Vec<u8>.

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

Converts a Python bool to a rust bool.

Fails with TypeError if the input is not a Python bool.

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

fn extract(py: Python, obj: &'s PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'s PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'s PyObject) -> 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(py: Python, obj: &'s PyObject) -> 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(py: Python, obj: &'s PyObject) -> 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(py: Python, obj: &'s PyObject) -> 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(py: Python, obj: &'s PyObject) -> 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(py: Python, obj: &'s PyObject) -> 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(py: Python, obj: &'s PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<i64>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<u64>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

Loading content...

Implementors

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source AssertionError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source AttributeError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source BaseException>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source BufferError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source EOFError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source EnvironmentError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source Exception>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source FloatingPointError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source IOError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source ImportError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source IndexError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source KeyError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source KeyboardInterrupt>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source LookupError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source MemoryError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source NameError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source NotImplementedError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source OSError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source OverflowError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source ReferenceError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source RuntimeError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source SyntaxError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source SystemError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source SystemExit>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source TypeError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source UnicodeDecodeError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source UnicodeEncodeError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source UnicodeTranslateError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source ValueError>

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

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<&'source ZeroDivisionError>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyBool>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyBytes>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyCapsule>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyDict>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyFloat>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyLong>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyList>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyModule>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyObject>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PySequence>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PySet>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyString>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyTuple>

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

fn extract(py: Python, obj: &'source PyObject) -> PyResult<&'source PyType>

impl<'source> FromPyObject<'source> for AssertionError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<AssertionError>

impl<'source> FromPyObject<'source> for AttributeError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<AttributeError>

impl<'source> FromPyObject<'source> for BaseException

fn extract(py: Python, obj: &'source PyObject) -> PyResult<BaseException>

impl<'source> FromPyObject<'source> for BufferError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<BufferError>

impl<'source> FromPyObject<'source> for EOFError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<EOFError>

impl<'source> FromPyObject<'source> for EnvironmentError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<EnvironmentError>

impl<'source> FromPyObject<'source> for Exception

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Exception>

impl<'source> FromPyObject<'source> for FloatingPointError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<FloatingPointError>

impl<'source> FromPyObject<'source> for IOError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<IOError>

impl<'source> FromPyObject<'source> for ImportError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<ImportError>

impl<'source> FromPyObject<'source> for IndexError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<IndexError>

impl<'source> FromPyObject<'source> for KeyError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<KeyError>

impl<'source> FromPyObject<'source> for KeyboardInterrupt

fn extract(py: Python, obj: &'source PyObject) -> PyResult<KeyboardInterrupt>

impl<'source> FromPyObject<'source> for LookupError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<LookupError>

impl<'source> FromPyObject<'source> for MemoryError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<MemoryError>

impl<'source> FromPyObject<'source> for NameError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<NameError>

impl<'source> FromPyObject<'source> for NotImplementedError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<NotImplementedError>

impl<'source> FromPyObject<'source> for OSError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<OSError>

impl<'source> FromPyObject<'source> for OverflowError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<OverflowError>

impl<'source> FromPyObject<'source> for ReferenceError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<ReferenceError>

impl<'source> FromPyObject<'source> for RuntimeError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<RuntimeError>

impl<'source> FromPyObject<'source> for SyntaxError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<SyntaxError>

impl<'source> FromPyObject<'source> for SystemError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<SystemError>

impl<'source> FromPyObject<'source> for SystemExit

fn extract(py: Python, obj: &'source PyObject) -> PyResult<SystemExit>

impl<'source> FromPyObject<'source> for TypeError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<TypeError>

impl<'source> FromPyObject<'source> for UnicodeDecodeError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<UnicodeDecodeError>

impl<'source> FromPyObject<'source> for UnicodeEncodeError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<UnicodeEncodeError>

impl<'source> FromPyObject<'source> for UnicodeTranslateError

fn extract(
    py: Python,
    obj: &'source PyObject
) -> PyResult<UnicodeTranslateError>

impl<'source> FromPyObject<'source> for ValueError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<ValueError>

impl<'source> FromPyObject<'source> for ZeroDivisionError

fn extract(py: Python, obj: &'source PyObject) -> PyResult<ZeroDivisionError>

impl<'source> FromPyObject<'source> for NoArgs

fn extract(py: Python, obj: &'source PyObject) -> PyResult<Self>

Returns Ok(NoArgs) if the input is an empty Python tuple. Otherwise, returns an error.

impl<'source> FromPyObject<'source> for PyBool

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyBool>

impl<'source> FromPyObject<'source> for PyBytes

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyBytes>

impl<'source> FromPyObject<'source> for PyCapsule

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyCapsule>

impl<'source> FromPyObject<'source> for PyDict

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyDict>

impl<'source> FromPyObject<'source> for PyFloat

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyFloat>

impl<'source> FromPyObject<'source> for PyLong

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyLong>

impl<'source> FromPyObject<'source> for PyList

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyList>

impl<'source> FromPyObject<'source> for PyModule

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyModule>

impl<'source> FromPyObject<'source> for PyObject

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyObject>

impl<'source> FromPyObject<'source> for PySequence

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PySequence>

impl<'source> FromPyObject<'source> for PySet

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PySet>

impl<'source> FromPyObject<'source> for PyString

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyString>

impl<'source> FromPyObject<'source> for PyTuple

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyTuple>

impl<'source> FromPyObject<'source> for PyType

fn extract(py: Python, obj: &'source PyObject) -> PyResult<PyType>

Loading content...