pyo3::types

Struct PyTuple

Source
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

Source

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.

Source

pub 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

Deprecated name for PyTuple::new.

Source

pub fn empty(py: Python<'_>) -> Bound<'_, PyTuple>

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

Source

pub fn empty_bound(py: Python<'_>) -> Bound<'_, PyTuple>

👎Deprecated since 0.23.0: renamed to PyTuple::empty

Deprecated name for PyTuple::empty.

Trait Implementations§

Source§

impl AsRef<PyAny> for PyTuple

Source§

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Deref for PyTuple

Source§

type Target = PyAny

The resulting type after dereferencing.
Source§

fn deref(&self) -> &PyAny

Dereferences the value.
Source§

impl PyTypeInfo for PyTuple

Source§

const NAME: &'static str = "PyTuple"

Class name.
Source§

const MODULE: Option<&'static str> = _

Module name, if any.
Source§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
Source§

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of
Deprecated name for PyTypeInfo::is_type_of.
Source§

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.
Source§

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object
Deprecated name for PyTypeInfo::type_object.
Source§

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.
Source§

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.
Source§

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of
Deprecated name for PyTypeInfo::is_exact_type_of.
Source§

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

Source§

const NAME: &'static str = const NAME: &'static str = <T as PyTypeInfo>::NAME;

Name of self. This is used in error messages, for example.
Source§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
Available on non-bootstrap only.
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.