Trait ToPyObject

Source

pub trait ToPyObject {
    type ObjectType: PythonObject;

    // Required method
    fn to_py_object(&self, py: Python<'_>) -> Self::ObjectType;

    // Provided methods
    fn into_py_object(self, py: Python<'_>) -> Self::ObjectType
       where Self: Sized { ... }
    fn with_borrowed_ptr<F, R>(&self, py: Python<'_>, f: F) -> R
       where F: FnOnce(*mut PyObject) -> R { ... }
}

Expand description

Conversion trait that allows various objects to be converted into Python objects.

Note: The associated type ObjectType is used so that some Rust types convert to a more precise type of Python object. For example, [T]::to_py_object() will result in a PyList. You can always calls val.to_py_object(py).into_py_object() in order to obtain PyObject (the second into_py_object() call via the PythonObject trait corresponds to the upcast from PyList to PyObject).

Required Associated Types§

Source

type ObjectType: PythonObject

Required Methods§

Source

fn to_py_object(&self, py: Python<'_>) -> Self::ObjectType

Converts self into a Python object.

Provided Methods§

Source

fn into_py_object(self, py: Python<'_>) -> Self::ObjectType
where Self: Sized,

Converts self into a Python object.

May be more efficient than to_py_object in some cases because it can move out of the input object.

Source

fn with_borrowed_ptr<F, R>(&self, py: Python<'_>, f: F) -> R
where 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.

May be more efficient than to_py_object because it does not need to touch any reference counts when the input object already is a Python object.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait ToPyObjectCopy item path

Required Associated Types§

type ObjectType: PythonObject

Required Methods§

fn to_py_object(&self, py: Python<'_>) -> Self::ObjectType

Provided Methods§

fn into_py_object(self, py: Python<'_>) -> Self::ObjectTypewhere Self: Sized,

fn with_borrowed_ptr<F, R>(&self, py: Python<'_>, f: F) -> Rwhere F: FnOnce(*mut PyObject) -> R,

Dyn Compatibility§

Implementations on Foreign Types§

impl ToPyObject for bool

type ObjectType = PyBool

fn to_py_object(&self, py: Python<'_>) -> PyBool

fn with_borrowed_ptr<F, R>(&self, _py: Python<'_>, f: F) -> Rwhere F: FnOnce(*mut PyObject) -> R,

impl ToPyObject for f32

type ObjectType = PyFloat

fn to_py_object(&self, py: Python<'_>) -> PyFloat

impl ToPyObject for f64

type ObjectType = PyFloat

fn to_py_object(&self, py: Python<'_>) -> PyFloat

impl ToPyObject for i8

type ObjectType = PyLong

fn to_py_object(&self, py: Python<'_>) -> PyLong

impl ToPyObject for i16

type ObjectType = PyLong

fn to_py_object(&self, py: Python<'_>) -> PyLong

impl ToPyObject for i32

type ObjectType = PyLong

fn to_py_object(&self, py: Python<'_>) -> PyLong

impl ToPyObject for i64

type ObjectType = PyLong

fn to_py_object(&self, py: Python<'_>) -> PyLong

impl ToPyObject for isize

type ObjectType = PyLong

fn to_py_object(&self, py: Python<'_>) -> PyLong

impl ToPyObject for str

type ObjectType = PyString

fn to_py_object(&self, py: Python<'_>) -> PyString

impl ToPyObject for u8

type ObjectType = PyLong

fn to_py_object(&self, py: Python<'_>) -> PyLong

impl ToPyObject for u16

type ObjectType = PyLong

fn to_py_object(&self, py: Python<'_>) -> PyLong

impl ToPyObject for u32

type ObjectType = PyLong

fn to_py_object(&self, py: Python<'_>) -> PyLong

impl ToPyObject for usize

type ObjectType = <u64 as ToPyObject>::ObjectType

fn to_py_object(&self, py: Python<'_>) -> <u64 as ToPyObject>::ObjectType

impl ToPyObject for String

type ObjectType = PyString

fn to_py_object(&self, py: Python<'_>) -> PyString

impl<'a> ToPyObject for Cow<'a, str>

type ObjectType = PyString

fn to_py_object(&self, py: Python<'_>) -> PyString

impl<'a, T> ToPyObject for &'a Twhere T: ToPyObject + ?Sized,

type ObjectType = <T as ToPyObject>::ObjectType

fn to_py_object(&self, py: Python<'_>) -> T::ObjectType

fn into_py_object(self, py: Python<'_>) -> T::ObjectType

fn with_borrowed_ptr<F, R>(&self, py: Python<'_>, f: F) -> Rwhere F: FnOnce(*mut PyObject) -> R,

impl<'p> ToPyObject for u64

type ObjectType = PyLong

fn to_py_object(&self, py: Python<'_>) -> PyLong

impl<A: ToPyObject> ToPyObject for (A,)

type ObjectType = PyTuple

fn to_py_object(&self, py: Python<'_>) -> PyTuple

fn into_py_object(self, py: Python<'_>) -> PyTuple

impl<A: ToPyObject, B: ToPyObject> ToPyObject for (A, B)

type ObjectType = PyTuple

fn to_py_object(&self, py: Python<'_>) -> PyTuple

fn into_py_object(self, py: Python<'_>) -> PyTuple

impl<A: ToPyObject, B: ToPyObject, C: ToPyObject> ToPyObject for (A, B, C)

type ObjectType = PyTuple

fn to_py_object(&self, py: Python<'_>) -> PyTuple

fn into_py_object(self, py: Python<'_>) -> PyTuple

impl<A: ToPyObject, B: ToPyObject, C: ToPyObject, D: ToPyObject> ToPyObject for (A, B, C, D)

type ObjectType = PyTuple

fn to_py_object(&self, py: Python<'_>) -> PyTuple

fn into_py_object(self, py: Python<'_>) -> PyTuple

Trait ToPyObject

fn into_py_object(self, py: Python<'_>) -> Self::ObjectType
where Self: Sized,

fn with_borrowed_ptr<F, R>(&self, py: Python<'_>, f: F) -> R
where F: FnOnce(*mut PyObject) -> R,

fn with_borrowed_ptr<F, R>(&self, _py: Python<'_>, f: F) -> R
where F: FnOnce(*mut PyObject) -> R,

impl<'a, T> ToPyObject for &'a T
where T: ToPyObject + ?Sized,

fn with_borrowed_ptr<F, R>(&self, py: Python<'_>, f: F) -> R
where F: FnOnce(*mut PyObject) -> R,

impl<K, V> ToPyObject for BTreeMap<K, V>
where K: Eq + ToPyObject, V: ToPyObject,

impl<K, V, H> ToPyObject for HashMap<K, V, H>
where K: Hash + Eq + ToPyObject, V: ToPyObject, H: BuildHasher,

impl<T> ToPyObject for Option<T>
where T: ToPyObject,

impl<T> ToPyObject for [T]
where T: ToPyObject,

impl<T> ToPyObject for Vec<T>
where T: ToPyObject,

impl<V> ToPyObject for BTreeSet<V>
where V: Eq + ToPyObject,

impl<V, H> ToPyObject for HashSet<V, H>
where V: Hash + Eq + ToPyObject, H: BuildHasher,