Struct cpython::PyList

pub struct PyList(_);

Represents a Python list.

Methods

impl PyList

pub fn new(py: Python, elements: &[PyObject]) -> PyList

Construct a new list with the given elements.

pub fn len(&self, _py: Python) -> usize

Gets the length of the list.

pub fn get_item(&self, py: Python, index: usize) -> PyObject

Gets the item at the specified index.

Panics if the index is out of range.

pub fn set_item(&self, _py: Python, index: usize, item: PyObject)

Sets the item at the specified index.

Panics if the index is out of range.

pub fn insert(&self, _py: Python, index: usize, item: PyObject)

Inserts an item at the specified index.

Panics if the index is out of range.

pub fn append(&self, _py: Python, item: PyObject)

Appends an item to the end of the list

pub fn iter<'a, 'p>(&'a self, py: Python<'p>) -> PyListIterator<'a, 'p>

Trait Implementations

impl<'s> FromPyObject<'s> for PyList

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

Extracts Self from the source PyObject.

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

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

Extracts Self from the source PyObject.

impl PythonObject for PyList

fn as_object(&self) -> &PyObject

Casts the Python object to PyObject.

fn into_object(self) -> PyObject

Casts the Python object to PyObject.

unsafe fn unchecked_downcast_from(obj: PyObject) -> Self

Unchecked downcast from PyObject to Self. Undefined behavior if the input object does not have the expected type.

unsafe fn unchecked_downcast_borrow_from<'a>(obj: &'a PyObject) -> &'a Self

Unchecked downcast from PyObject to Self. Undefined behavior if the input object does not have the expected type.

impl PythonObjectWithCheckedDowncast for PyList

fn downcast_from<'p>(
    py: Python<'p>,
    obj: PyObject
) -> Result<PyList, PythonObjectDowncastError<'p>>

Cast from PyObject to a concrete Python object type.

fn downcast_borrow_from<'a, 'p>(
    py: Python<'p>,
    obj: &'a PyObject
) -> Result<&'a PyList, PythonObjectDowncastError<'p>>

Cast from PyObject to a concrete Python object type.

impl PythonObjectWithTypeObject for PyList

fn type_object(py: Python) -> PyType

Retrieves the type object for this Python object type.

impl ToPyObject for PyList

Identity conversion: allows using existing PyObject instances where T: ToPyObject is expected.

type ObjectType = PyList

fn to_py_object(&self, py: Python) -> PyList

Converts self into a Python object.

fn into_py_object(self, _py: Python) -> PyList

Converts self into a Python object.

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.