Struct PyIter

pub struct PyIter<O = PyObjectRef>(/* private fields */)
where
    O: Borrow<PyObject>;

Iterator Protocol

Implementations

impl PyIter<PyObjectRef>

pub fn check(obj: &PyObject) -> bool

impl<O> PyIter<O>

where O: Borrow<PyObject>,

pub fn new(obj: O) -> Self

pub fn next(&self, vm: &VirtualMachine) -> PyResult<PyIterReturn>

pub fn iter<'a, 'b, U>( &'b self, vm: &'a VirtualMachine, ) -> PyResult<PyIterIter<'a, U, &'b PyObject>>

pub fn iter_without_hint<'a, 'b, U>( &'b self, vm: &'a VirtualMachine, ) -> PyResult<PyIterIter<'a, U, &'b PyObject>>

impl PyIter<PyObjectRef>

pub fn into_iter<U>( self, vm: &VirtualMachine, ) -> PyResult<PyIterIter<'_, U, PyObjectRef>>

Returns an iterator over this sequence of objects.

Methods from Deref<Target = PyObject>

pub fn try_to_value<'a, T>(&'a self, vm: &VirtualMachine) -> PyResult<T>

where T: 'a + TryFromBorrowedObject<'a>,

pub fn try_to_ref<'a, T>(&'a self, vm: &VirtualMachine) -> PyResult<&'a Py<T>>

where T: 'a + PyPayload,

pub fn try_value_with<T, F, R>(&self, f: F, vm: &VirtualMachine) -> PyResult<R>

where T: PyPayload, F: Fn(&T) -> PyResult<R>,

pub fn try_bytes_like<R>( &self, vm: &VirtualMachine, f: impl FnOnce(&[u8]) -> R, ) -> PyResult<R>

pub fn try_rw_bytes_like<R>( &self, vm: &VirtualMachine, f: impl FnOnce(&mut [u8]) -> R, ) -> PyResult<R>

pub fn as_interned_str( &self, vm: &VirtualMachine, ) -> Option<&'static PyStrInterned>

pub fn downgrade( &self, callback: Option<PyObjectRef>, vm: &VirtualMachine, ) -> PyResult<PyRef<PyWeak>>

pub fn get_weak_references(&self) -> Option<Vec<PyRef<PyWeak>>>

pub fn payload_is<T: PyObjectPayload>(&self) -> bool

pub unsafe fn payload_unchecked<T: PyObjectPayload>(&self) -> &T

Force to return payload as T.

Safety

The actual payload type must be T.

pub fn payload<T: PyObjectPayload>(&self) -> Option<&T>

pub fn class(&self) -> &Py<PyType>

pub fn set_class(&self, typ: PyTypeRef, vm: &VirtualMachine)

pub fn payload_if_exact<T: PyObjectPayload + PyPayload>( &self, vm: &VirtualMachine, ) -> Option<&T>

pub fn dict(&self) -> Option<PyDictRef>

pub fn set_dict(&self, dict: PyDictRef) -> Result<(), PyDictRef>

Set the dict field. Returns Err(dict) if this object does not have a dict field in the first place.

pub fn payload_if_subclass<T: PyPayload>( &self, vm: &VirtualMachine, ) -> Option<&T>

pub fn downcast_ref<T: PyObjectPayload>(&self) -> Option<&Py<T>>

pub fn downcast_ref_if_exact<T: PyObjectPayload + PyPayload>( &self, vm: &VirtualMachine, ) -> Option<&Py<T>>

pub unsafe fn downcast_unchecked_ref<T: PyObjectPayload>(&self) -> &Py<T>

Safety

T must be the exact payload type

pub fn strong_count(&self) -> usize

pub fn weak_count(&self) -> Option<usize>

pub fn as_raw(&self) -> *const PyObject

pub fn to_callable(&self) -> Option<PyCallable<'_>>

pub fn is_callable(&self) -> bool

pub fn call(&self, args: impl IntoFuncArgs, vm: &VirtualMachine) -> PyResult

PyObject_CallArg series

pub fn call_with_args(&self, args: FuncArgs, vm: &VirtualMachine) -> PyResult

PyObject_Call

pub fn to_mapping(&self) -> PyMapping<'_>

pub fn to_number(&self) -> PyNumber<'_>

pub fn try_index_opt(&self, vm: &VirtualMachine) -> Option<PyResult<PyIntRef>>

pub fn try_index(&self, vm: &VirtualMachine) -> PyResult<PyIntRef>

pub fn try_int(&self, vm: &VirtualMachine) -> PyResult<PyIntRef>

pub fn try_float_opt( &self, vm: &VirtualMachine, ) -> Option<PyResult<PyRef<PyFloat>>>

pub fn try_float(&self, vm: &VirtualMachine) -> PyResult<PyRef<PyFloat>>

pub fn get_iter(&self, vm: &VirtualMachine) -> PyResult<PyIter>

Takes an object and returns an iterator for it. This is typically a new iterator but if the argument is an iterator, this returns itself.

pub fn get_aiter(&self, vm: &VirtualMachine) -> PyResult

pub fn has_attr<'a>( &self, attr_name: impl AsPyStr<'a>, vm: &VirtualMachine, ) -> PyResult<bool>

pub fn get_attr<'a>( &self, attr_name: impl AsPyStr<'a>, vm: &VirtualMachine, ) -> PyResult

pub fn call_set_attr( &self, vm: &VirtualMachine, attr_name: &Py<PyStr>, attr_value: PySetterValue, ) -> PyResult<()>

pub fn set_attr<'a>( &self, attr_name: impl AsPyStr<'a>, attr_value: impl Into<PyObjectRef>, vm: &VirtualMachine, ) -> PyResult<()>

pub fn generic_setattr( &self, attr_name: &Py<PyStr>, value: PySetterValue, vm: &VirtualMachine, ) -> PyResult<()>

pub fn generic_getattr(&self, name: &Py<PyStr>, vm: &VirtualMachine) -> PyResult

pub fn generic_getattr_opt( &self, name_str: &Py<PyStr>, dict: Option<PyDictRef>, vm: &VirtualMachine, ) -> PyResult<Option<PyObjectRef>>

CPython _PyObject_GenericGetAttrWithDict

pub fn del_attr<'a>( &self, attr_name: impl AsPyStr<'a>, vm: &VirtualMachine, ) -> PyResult<()>

pub fn rich_compare_bool( &self, other: &Self, opid: PyComparisonOp, vm: &VirtualMachine, ) -> PyResult<bool>

pub fn repr(&self, vm: &VirtualMachine) -> PyResult<PyStrRef>

pub fn ascii(&self, vm: &VirtualMachine) -> PyResult<AsciiString>

pub fn str(&self, vm: &VirtualMachine) -> PyResult<PyStrRef>

pub fn is_subclass(&self, cls: &PyObject, vm: &VirtualMachine) -> PyResult<bool>

Determines if self is a subclass of cls, either directly, indirectly or virtually via the subclasscheck magic method.

pub fn is_instance(&self, cls: &PyObject, vm: &VirtualMachine) -> PyResult<bool>

Determines if self is an instance of cls, either directly, indirectly or virtually via the instancecheck magic method.

pub fn hash(&self, vm: &VirtualMachine) -> PyResult<PyHash>

pub fn obj_type(&self) -> PyObjectRef

pub fn type_check(&self, typ: &Py<PyType>) -> bool

pub fn length_opt(&self, vm: &VirtualMachine) -> Option<PyResult<usize>>

pub fn length(&self, vm: &VirtualMachine) -> PyResult<usize>

pub fn get_item<K: DictKey + ?Sized>( &self, needle: &K, vm: &VirtualMachine, ) -> PyResult

pub fn set_item<K: DictKey + ?Sized>( &self, needle: &K, value: PyObjectRef, vm: &VirtualMachine, ) -> PyResult<()>

pub fn del_item<K: DictKey + ?Sized>( &self, needle: &K, vm: &VirtualMachine, ) -> PyResult<()>

pub fn to_sequence(&self) -> PySequence<'_>

Trait Implementations

impl<O> AsRef<PyObject> for PyIter<O>

where O: Borrow<PyObject>,

fn as_ref(&self) -> &PyObject

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

impl<O> Borrow<PyObject> for PyIter<O>

where O: Borrow<PyObject>,

fn borrow(&self) -> &PyObject

Immutably borrows from an owned value.

impl<O> Clone for PyIter<O>

where O: Borrow<PyObject> + Clone,

fn clone(&self) -> PyIter<O>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<O> Debug for PyIter<O>

where O: Borrow<PyObject> + Debug,

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

Formats the value using the given formatter.

impl<O> Deref for PyIter<O>

where O: Borrow<PyObject>,

type Target = PyObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<PyIter> for PyObjectRef

fn from(value: PyIter<PyObjectRef>) -> PyObjectRef

Converts to this type from the input type.

impl ToPyObject for PyIter<PyObjectRef>

fn to_pyobject(self, _vm: &VirtualMachine) -> PyObjectRef

impl<O: Borrow<PyObject>> Traverse for PyIter<O>

fn traverse(&self, tracer_fn: &mut TraverseFn<'_>)

impl traverse() with caution! Following those guideline so traverse doesn’t cause memory error!:

impl TryFromObject for PyIter<PyObjectRef>

fn try_from_object( vm: &VirtualMachine, iter_target: PyObjectRef, ) -> PyResult<Self>

Attempt to convert a Python object to a value of this type.