Struct pyo3::types::PySequence

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

Represents a reference to a python object supporting the sequence protocol.

Methods

impl PySequence

pub fn len(&self) -> PyResult<isize>

Returns the number of objects in sequence. This is equivalent to Python len().

pub fn is_empty(&self) -> PyResult<bool>

pub fn concat(&self, other: &PySequence) -> PyResult<&PySequence>

Return the concatenation of o1 and o2. Equivalent to python o1 + o2

pub fn repeat(&self, count: isize) -> PyResult<&PySequence>

Return the result of repeating sequence object o count times. Equivalent to python o * count NB: Python accepts negative counts; it returns an empty Sequence.

pub fn in_place_concat(&self, other: &PySequence) -> PyResult<()>

Concatenate of o1 and o2 on success. Equivalent to python o1 += o2

pub fn in_place_repeat(&self, count: isize) -> PyResult<()>

Repeate sequence object o count times and store in self. Equivalent to python o *= count NB: Python accepts negative counts; it empties the Sequence.

pub fn get_item(&self, index: isize) -> PyResult<&PyAny>

Return the ith element of the Sequence. Equivalent to python o[index]

pub fn get_slice(&self, begin: isize, end: isize) -> PyResult<&PyAny>

Return the slice of sequence object o between begin and end. This is the equivalent of the Python expression o[begin:end]

pub fn set_item<I>(&self, i: isize, item: I) -> PyResult<()> where
    I: ToBorrowedObject, 

Assign object v to the ith element of o. Equivalent to Python statement o[i] = v

pub fn del_item(&self, i: isize) -> PyResult<()>

Delete the ith element of object o. Python statement del o[i]

pub fn set_slice(&self, i1: isize, i2: isize, v: &PyAny) -> PyResult<()>

Assign the sequence object v to the slice in sequence object o from i1 to i2. This is the equivalent of the Python statement o[i1:i2] = v

pub fn del_slice(&self, i1: isize, i2: isize) -> PyResult<()>

Delete the slice in sequence object o from i1 to i2. equivalent of the Python statement del o[i1:i2]

pub fn count<V>(&self, value: V) -> PyResult<usize> where
    V: ToBorrowedObject, 

Return the number of occurrences of value in o, that is, return the number of keys for which o[key] == value

pub fn contains<V>(&self, value: V) -> PyResult<bool> where
    V: ToBorrowedObject, 

Determine if o contains value. this is equivalent to the Python expression value in o

pub fn index<V>(&self, value: V) -> PyResult<usize> where
    V: ToBorrowedObject, 

Return the first index i for which o[i] == value. This is equivalent to the Python expression o.index(value)

pub fn list(&self) -> PyResult<&PyList>

Return a fresh list based on the Sequence.

pub fn tuple(&self) -> PyResult<&PyTuple>

Return a fresh tuple based on the Sequence.

Trait Implementations

impl AsPyPointer for PySequence

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PySequence

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl PartialEq<PySequence> for PySequence

fn eq(&self, o: &PySequence) -> 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 PyNativeType for PySequence

fn py(&self) -> Python

impl<'v> PyTryFrom<'v> for PySequence

fn try_from<V: Into<&'v PyAny>>(
    value: V
) -> Result<&'v PySequence, PyDowncastError>

Cast from a concrete Python object type to PyObject.

fn try_from_exact<V: Into<&'v PyAny>>(
    value: V
) -> Result<&'v PySequence, PyDowncastError>

Cast from a concrete Python object type to PyObject. With exact type check.

fn try_from_mut<V: Into<&'v PyAny>>(
    value: V
) -> Result<&'v mut PySequence, PyDowncastError>

Cast from a concrete Python object type to PyObject.

fn try_from_mut_exact<V: Into<&'v PyAny>>(
    value: V
) -> Result<&'v mut PySequence, PyDowncastError>

Cast from a concrete Python object type to PyObject. With exact type check.

unsafe fn try_from_unchecked<V: Into<&'v PyAny>>(value: V) -> &'v PySequence

Cast a PyAny to a specific type of PyObject. The caller must have already verified the reference is for this type.

unsafe fn try_from_mut_unchecked<V: Into<&'v PyAny>>(
    value: V
) -> &'v mut PySequence

Cast a PyAny to a specific type of PyObject. The caller must have already verified the reference is for this type.