#[repr(transparent)]pub struct PyTuple(PyAny);
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>
.
Tuple Fields§
§0: PyAny
Implementations§
Source§impl PyTuple
impl PyTuple
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self>
#[doc(hidden)] pub const _PYO3_INTROSPECTION_ID: &'static str = ":: std :: option :: Option :: Some(\"builtins\")PyTuple"
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.
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
Returns the PyTypeObject instance for this type.
Source§fn is_type_of(obj: &Bound<'_, PyAny>) -> bool
fn is_type_of(obj: &Bound<'_, PyAny>) -> bool
Checks if
object
is an instance of this type or a subclass of this type.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> AssertNotZeroSized for T
impl<T> AssertNotZeroSized for T
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
Mutably borrows from an owned value. Read more
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>
Converts
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>
Converts
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 moreSource§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§impl<T> SizedTypeProperties for T
impl<T> SizedTypeProperties for T
Source§#[doc(hidden)] const IS_ZST: bool = _
#[doc(hidden)] const IS_ZST: bool = _
🔬This is a nightly-only experimental API. (
sized_type_properties
)Source§#[doc(hidden)] const LAYOUT: Layout = _
#[doc(hidden)] const LAYOUT: Layout = _
🔬This is a nightly-only experimental API. (
sized_type_properties
)Source§#[doc(hidden)] const MAX_SLICE_LEN: usize = _
#[doc(hidden)] const MAX_SLICE_LEN: usize = _
🔬This is a nightly-only experimental API. (
sized_type_properties
)The largest safe length for a
[Self]
. Read more