Struct pyo3::types::PyList

#[repr(transparent)]
pub struct PyList(_, _);

Represents a Python list.

Methods

impl PyList

pub fn new<T, U>(
    py: Python,
    elements: impl IntoIterator<Item = T, IntoIter = U>
) -> &PyList where
    T: ToPyObject,
    U: ExactSizeIterator<Item = T>, 

Construct a new list with the given elements.

pub fn empty(py: Python) -> &PyList

Construct a new empty list.

pub fn len(&self) -> usize

Gets the length of the list.

pub fn is_empty(&self) -> bool

Check if list is empty.

pub fn get_item(&self, index: isize) -> &PyAny

Gets the item at the specified index.

Panics if the index is out of range.

pub fn get_parked_item(&self, index: isize) -> PyObject

Gets the item at the specified index.

Panics if the index is out of range.

pub fn set_item<I>(&self, index: isize, item: I) -> PyResult<()> where
    I: ToPyObject, 

Sets the item at the specified index.

Panics if the index is out of range.

pub fn append<I>(&self, item: I) -> PyResult<()> where
    I: ToBorrowedObject, 

Appends an item at the list.

pub fn insert<I>(&self, index: isize, item: I) -> PyResult<()> where
    I: ToBorrowedObject, 

Inserts an item at the specified index.

Panics if the index is out of range.

pub fn iter(&self) -> PyListIterator

Returns an iterator over the tuple items.

pub fn sort(&self) -> PyResult<()>

Sorts the list in-place. Equivalent to python l.sort()

pub fn reverse(&self) -> PyResult<()>

Reverses the list in-place. Equivalent to python l.reverse()

Trait Implementations

impl AsPyPointer for PyList

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyList

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Debug for PyList

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for PyList

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> From<&'a PyList> for &'a PyAny

fn from(ob: &'a PyList) -> Self

Performs the conversion.

impl<'a> IntoIterator for &'a PyList

type Item = &'a PyAny

The type of the elements being iterated over.

type IntoIter = PyListIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<PyList> for PyList

fn eq(&self, o: &PyList) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PyNativeType for PyList

fn py(&self) -> Python

impl PyObjectAlloc for PyList

unsafe fn alloc(_py: Python) -> *mut PyObject

unsafe fn dealloc(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object and frees the memory (usually by calling ptr->ob_type->tp_free). This function is used as tp_dealloc implementation.

unsafe fn drop(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object.

impl PyTypeInfo for PyList

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

const SIZE: usize

Size of the rust PyObject structure (PyObject + rust structure)

const OFFSET: isize

Type instance offset inside PyObject structure

unsafe fn type_object() -> &'static mut PyTypeObject

PyTypeObject instance for this type, which might still need to be initialized

fn is_instance(ptr: &PyAny) -> bool

Check if *mut ffi::PyObject is instance of this type

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(object: &PyAny) -> bool

Check if *mut ffi::PyObject is exact instance of this type

impl PyTypeObject for PyList

fn init_type() -> NonNull<PyTypeObject>

This function must make sure that the corresponding type object gets initialized exactly once and return it.

fn type_object() -> Py<PyType>

Returns the safe abstraction over the type object from PyTypeObject::init_type

impl ToPyObject for PyList

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.