pub struct PyTuple(/* private fields */);
Expand description
Represents a Python tuple
object.
Values of this type are accessed via PyO3’s smart pointers, e.g. as
Py<PyTuple>
or Bound<'py, PyTuple>
.
For APIs available on tuple
objects, see the PyTupleMethods
trait which is implemented for
Bound<'py, PyTuple>
.
Implementations§
source§impl PyTuple
impl PyTuple
sourcepub fn new<'py, T, U>(
py: Python<'py>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> PyResult<Bound<'py, PyTuple>>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, PyTuple>>where
T: IntoPyObject<'py>,
U: ExactSizeIterator<Item = T>,
Constructs a new tuple with the given elements.
If you want to create a PyTuple
with elements of different or unknown types, or from an
iterable that doesn’t implement ExactSizeIterator
, create a Rust tuple with the given
elements and convert it at once using into_py
.
§Examples
use pyo3::prelude::*;
use pyo3::types::PyTuple;
Python::with_gil(|py| {
let elements: Vec<i32> = vec![0, 1, 2, 3, 4, 5];
let tuple = PyTuple::new(py, elements)?;
assert_eq!(format!("{:?}", tuple), "(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 using Vec
<T>
or &[T]
will always succeed.
sourcepub fn new_bound<T, U>(
py: Python<'_>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> Bound<'_, PyTuple>where
T: ToPyObject,
U: ExactSizeIterator<Item = T>,
👎Deprecated since 0.23.0: renamed to PyTuple::new
pub fn new_bound<T, U>(
py: Python<'_>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> Bound<'_, PyTuple>where
T: ToPyObject,
U: ExactSizeIterator<Item = T>,
PyTuple::new
Deprecated name for PyTuple::new
.
sourcepub fn empty(py: Python<'_>) -> Bound<'_, PyTuple>
pub fn empty(py: Python<'_>) -> Bound<'_, PyTuple>
Constructs an empty tuple (on the Python side, a singleton object).
sourcepub fn empty_bound(py: Python<'_>) -> Bound<'_, PyTuple>
👎Deprecated since 0.23.0: renamed to PyTuple::empty
pub fn empty_bound(py: Python<'_>) -> Bound<'_, PyTuple>
PyTuple::empty
Deprecated name for PyTuple::empty
.
Trait Implementations§
source§impl PyTypeInfo for PyTuple
impl PyTypeInfo for PyTuple
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 PyTuple
Auto Trait Implementations§
impl !Freeze for PyTuple
impl !RefUnwindSafe for PyTuple
impl !Send for PyTuple
impl !Sync for PyTuple
impl Unpin for PyTuple
impl UnwindSafe for PyTuple
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