Struct pyo3::types::PyTuple

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

Represents a Python tuple object.

This type is immutable.

Methods

impl PyTuple

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

Constructs a new tuple with the given elements.

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

Constructs an empty tuple (on the Python side, a singleton object).

pub fn len(&self) -> usize

Gets the length of the tuple.

pub fn is_empty(&self) -> bool

Checks if the tuple is empty.

pub fn slice(&self, low: isize, high: isize) -> Py<PyTuple>

Takes a slice of the tuple pointed from low to high and returns it as a new tuple.

pub fn split_from(&self, low: isize) -> Py<PyTuple>

Takes a slice of the tuple from low to the end and returns it as a new tuple.

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

Gets the tuple item at the specified index.

Panics if the index is out of range.

pub fn as_slice(&self) -> &[PyObject]

Returns self as a slice of objects.

pub fn iter(&self) -> PyTupleIterator

Returns an iterator over the tuple items.

Trait Implementations

impl AsPyPointer for PyTuple

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyTuple

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Debug for PyTuple

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

Formats the value using the given formatter.

impl Display for PyTuple

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

Formats the value using the given formatter.

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

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

Performs the conversion.

impl<'a> FromPy<&'a PyTuple> for Py<PyTuple>

fn from_py(tuple: &'a PyTuple, _py: Python) -> Py<PyTuple>

Performs the conversion.

impl<'py> FromPyObject<'py> for &'py PyTuple

fn extract(obj: &'py PyAny) -> PyResult<Self>

Extracts Self from the source PyObject.

impl<'a> IntoIterator for &'a PyTuple

type Item = &'a PyAny

The type of the elements being iterated over.

type IntoIter = PyTupleIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<PyTuple> for PyTuple

fn eq(&self, o: &PyTuple) -> 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 PyLayout<PyTuple> for PyObject

const IS_NATIVE_TYPE: bool

fn get_super(&mut self) -> Option<&mut T::BaseLayout>

unsafe fn py_init(&mut self, _value: T)

unsafe fn py_drop(&mut self, _py: Python)

impl PyNativeType for PyTuple

fn py(&self) -> Python

impl PyTypeInfo for PyTuple

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

type Layout = PyObject

Layout

type BaseLayout = PyObject

Layout of Basetype.

type Initializer = PyNativeTypeInitializer<Self>

Initializer for layout

type AsRefTarget = Self

Utility type to make AsPyRef work

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

fn type_object() -> &'static PyTypeObject

PyTypeObject instance for this type.

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 ToPyObject for PyTuple

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

Converts self into a Python object.