pub struct PyList(/* private fields */);
Expand description
Represents a Python list
.
Values of this type are accessed via PyO3’s smart pointers, e.g. as
Py<PyList>
or Bound<'py, PyList>
.
For APIs available on list
objects, see the PyListMethods
trait which is implemented for
Bound<'py, PyDict>
.
Implementations§
source§impl PyList
impl PyList
sourcepub fn new<'py, T, U>(
py: Python<'py>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> PyResult<Bound<'py, PyList>>where
T: IntoPyObject<'py>,
U: ExactSizeIterator<Item = T>,
pub fn new<'py, T, U>(
py: Python<'py>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> PyResult<Bound<'py, PyList>>where
T: IntoPyObject<'py>,
U: ExactSizeIterator<Item = T>,
Constructs a new list with the given elements.
If you want to create a PyList
with elements of different or unknown types, or from an
iterable that doesn’t implement ExactSizeIterator
, use PyListMethods::append
.
§Examples
use pyo3::prelude::*;
use pyo3::types::PyList;
Python::with_gil(|py| {
let elements: Vec<i32> = vec![0, 1, 2, 3, 4, 5];
let list = PyList::new(py, elements)?;
assert_eq!(format!("{:?}", list), "[0, 1, 2, 3, 4, 5]");
})
§Panics
This function will panic if element
’s ExactSizeIterator
implementation is incorrect.
All standard library structures implement this trait correctly, if they do, so calling this
function with (for example) Vec
<T>
or &[T]
will always succeed.
sourcepub fn new_bound<T, U>(
py: Python<'_>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> Bound<'_, PyList>where
T: ToPyObject,
U: ExactSizeIterator<Item = T>,
👎Deprecated since 0.23.0: renamed to PyList::new
pub fn new_bound<T, U>(
py: Python<'_>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> Bound<'_, PyList>where
T: ToPyObject,
U: ExactSizeIterator<Item = T>,
PyList::new
Deprecated name for PyList::new
.
sourcepub fn empty_bound(py: Python<'_>) -> Bound<'_, PyList>
👎Deprecated since 0.23.0: renamed to PyList::empty
pub fn empty_bound(py: Python<'_>) -> Bound<'_, PyList>
PyList::empty
Deprecated name for PyList::empty
.
Trait Implementations§
source§impl PyTypeInfo for PyList
impl PyTypeInfo for PyList
source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
source§fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool
fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool
PyTypeInfo::is_type_of
PyTypeInfo::is_type_of
.source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
source§fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
PyTypeInfo::type_object
PyTypeInfo::type_object
.source§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
object
is an instance of this type or a subclass of this type.source§fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
object
is an instance of this type.source§fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool
PyTypeInfo::is_exact_type_of
PyTypeInfo::is_exact_type_of
.impl DerefToPyAny for PyList
Auto Trait Implementations§
impl !Freeze for PyList
impl !RefUnwindSafe for PyList
impl !Send for PyList
impl !Sync for PyList
impl Unpin for PyList
impl UnwindSafe for PyList
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more