Struct PyList 

pub struct PyList { /* private fields */ }

Implementations

impl PyList

pub fn new_ref(elements: Vec<PyObjectRef>, ctx: &Context) -> PyRef<Self>

👎Deprecated:

use PyList::from(…).into_ref() instead

pub fn borrow_vec(&self) -> PyMappedRwLockReadGuard<'_, [PyObjectRef]>

pub fn borrow_vec_mut(&self) -> PyRwLockWriteGuard<'_, Vec<PyObjectRef>>

impl PyList

pub fn __len__(&self) -> usize

Trait Implementations

impl AsMapping for PyList

fn as_mapping() -> &'static PyMappingMethods

fn mapping_downcast(mapping: PyMapping<'_>) -> &Py<Self>

fn extend_slots(slots: &mut PyTypeSlots)

const __OWN_METHOD_DEFS: &'static [PyMethodDef] = _

fn __extend_py_class(ctx: &'static Context, class: &'static Py<PyType>)

fn __extend_slots(slots: &mut PyTypeSlots)

impl AsSequence for PyList

fn as_sequence() -> &'static PySequenceMethods

fn sequence_downcast(seq: PySequence<'_>) -> &Py<Self>

fn extend_slots(slots: &mut PyTypeSlots)

const __OWN_METHOD_DEFS: &'static [PyMethodDef] = _

fn __extend_py_class(ctx: &'static Context, class: &'static Py<PyType>)

fn __extend_slots(slots: &mut PyTypeSlots)

impl Comparable for PyList

fn cmp( zelf: &Py<Self>, other: &PyObject, op: PyComparisonOp, vm: &VirtualMachine, ) -> PyResult<PyComparisonValue>

fn slot_richcompare( zelf: &PyObject, other: &PyObject, op: PyComparisonOp, vm: &VirtualMachine, ) -> PyResult<Either<PyObjectRef, PyComparisonValue>>

const __OWN_METHOD_DEFS: &'static [PyMethodDef] = _

fn __extend_py_class(ctx: &'static Context, class: &'static Py<PyType>)

fn __extend_slots(slots: &mut PyTypeSlots)

impl Constructor for PyList

type Args = FuncArgs

fn py_new( _cls: &Py<PyType>, _args: FuncArgs, _vm: &VirtualMachine, ) -> PyResult<Self>

Creates the payload for this type. In most cases, just implement this method and let the default slot_new handle wrapping with the correct type.

const DROP_KWARGS_WHEN_INIT_OVERRIDDEN: bool = false

When true, extra keywords are dropped if a subclass replaced tp_init.

fn slot_new(cls: PyTypeRef, args: FuncArgs, vm: &VirtualMachine) -> PyResult

The type slot for __new__. Override this only when you need special behavior beyond simple payload creation.

const __OWN_METHOD_DEFS: &'static [PyMethodDef] = _

fn __extend_py_class(ctx: &'static Context, class: &'static Py<PyType>)

fn __extend_slots(slots: &mut PyTypeSlots)

impl Debug for PyList

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

Formats the value using the given formatter.

impl Default for PyList

fn default() -> Self

Returns the “default value” for a type.

impl From<Vec<PyObjectRef>> for PyList

fn from(elements: Vec<PyObjectRef>) -> Self

Converts to this type from the input type.

impl FromIterator<PyObjectRef> for PyList

fn from_iter<T: IntoIterator<Item = PyObjectRef>>(iter: T) -> Self

Creates a value from an iterator.

impl Initializer for PyList

type Args = PositionalIterable

fn slot_init( zelf: &PyObject, args: FuncArgs, vm: &VirtualMachine, ) -> PyResult<()>

fn init(zelf: &Py<Self>, args: Self::Args, vm: &VirtualMachine) -> PyResult<()>

const __OWN_METHOD_DEFS: &'static [PyMethodDef] = _

fn __extend_py_class(ctx: &'static Context, class: &'static Py<PyType>)

fn __extend_slots(slots: &mut PyTypeSlots)

impl Iterable for PyList

fn iter(zelf: PyRef<Self>, vm: &VirtualMachine) -> PyResult

fn slot_iter(zelf: PyObjectRef, vm: &VirtualMachine) -> PyResult

fn extend_slots(_slots: &mut PyTypeSlots)

const __OWN_METHOD_DEFS: &'static [PyMethodDef] = _

fn __extend_py_class(ctx: &'static Context, class: &'static Py<PyType>)

fn __extend_slots(slots: &mut PyTypeSlots)

impl MaybeTraverse for PyList

const HAS_TRAVERSE: bool = true

if is traceable, will be used by vtable to determine

const HAS_CLEAR: bool = true

if has clear implementation for circular reference resolution (tp_clear)

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

fn try_clear(&mut self, out: &mut Vec<PyObjectRef>)

impl MutObjectSequenceOp for PyList

type Inner = [PyObjectRef]

fn do_get(index: usize, inner: &[PyObjectRef]) -> Option<&PyObject>

fn do_lock(&self) -> impl Deref<Target = [PyObjectRef]>

fn mut_count(&self, vm: &VirtualMachine, needle: &PyObject) -> PyResult<usize>

fn mut_index_range( &self, vm: &VirtualMachine, needle: &PyObject, range: Range<usize>, ) -> PyResult<Optioned<usize>>

fn mut_index( &self, vm: &VirtualMachine, needle: &PyObject, ) -> PyResult<Optioned<usize>>

fn mut_contains(&self, vm: &VirtualMachine, needle: &PyObject) -> PyResult<bool>

fn _mut_iter_equal_skeleton<F, const SHORT: bool>( &self, vm: &VirtualMachine, needle: &PyObject, range: Range<usize>, f: F, ) -> PyResult<Optioned<usize>>

where F: FnMut(),

impl PyClassDef for PyList

const NAME: &'static str = "list"

const MODULE_NAME: Option<&'static str> = None

const TP_NAME: &'static str = "list"

const DOC: ItemDoc

const ATTR_DOCS: &'static [(&'static str, u32, u32)]

Attribute name → database span, sorted by name. (u32::MAX, 0) is an explicit empty doc.

const BASICSIZE: usize

const UNHASHABLE: bool = true

const MEMBERS: &'static [PyMemberSpec]

type Base = PyBaseObject

fn assert_member_layout()

const ITEMSIZE: usize = 0

impl PyClassImpl for PyList

const TP_FLAGS: PyTypeFlags

const INTERNAL_DOC: ItemDoc

Signature-bearing class doc. ItemDoc::NONE when the constructor has no signature.

const METHOD_DEFS: &'static [PyMethodDef]

fn impl_extend_class(ctx: &'static Context, class: &'static Py<PyType>)

fn extend_slots(slots: &mut PyTypeSlots)

fn extend_class(ctx: &'static Context, class: &'static Py<PyType>)

where Self: Sized,

fn make_static_type() -> PyTypeRef

where Self: StaticType + Sized,

fn make_slots() -> PyTypeSlots

impl PyPayload for PyList

const MAX_FREELIST: usize = 80

Maximum number of objects to keep in the freelist.

const HAS_FREELIST: bool = true

Whether this type has a freelist. Types with freelists require immediate (non-deferred) GC untracking during dealloc to prevent race conditions when the object is reused.

fn class(ctx: &Context) -> &'static Py<PyType>

unsafe fn freelist_push(obj: *mut PyObject) -> bool

Try to push a dead object onto this type’s freelist for reuse. Returns true if the object was stored (caller must NOT free the memory). Called after tp_clear, so the payload is a cleared husk; implementations must not rely on its pre-clear contents.

unsafe fn freelist_pop(_payload: &Self) -> Option<NonNull<PyObject>>

Try to pop a pre-allocated object from this type’s freelist. The returned pointer still has the old payload; the caller must reinitialize ref_count, gc_bits, and payload.

const PAYLOAD_TYPE_ID: TypeId = _

unsafe fn validate_downcastable_from(_obj: &PyObject) -> bool

Safety

fn try_downcast_from(obj: &PyObject, vm: &VirtualMachine) -> PyResult<()>

const NEW_REF_UNTRACKED: bool = false

Whether PyRef::new_ref skips auto-tracking this type in the GC even when it would otherwise qualify (has traverse, dict, or heap type). Such objects are created untracked and must be tracked explicitly if and when they can become part of a reference cycle. Used by FrameObject, which is created untracked and tracked lazily only on escape.

fn into_pyobject(self, vm: &VirtualMachine) -> PyObjectRef

where Self: Debug,

fn _into_ref(self, cls: PyTypeRef, ctx: &Context) -> PyRef<Self>

where Self: Debug,

fn into_exact_ref(self, ctx: &Context) -> PyRefExact<Self>

where Self: Debug,

fn into_ref(self, ctx: &Context) -> PyRef<Self>

where Self: Debug,

fn into_ref_with_type( self, vm: &VirtualMachine, cls: PyTypeRef, ) -> PyResult<PyRef<Self>>

where Self: Debug,

fn into_ref_with_type_lazy_dict( self, vm: &VirtualMachine, cls: PyTypeRef, ) -> PyResult<PyRef<Self>>

where Self: Debug,

Like into_ref_with_type, but leaves the instance __dict__ unallocated until the first attribute write or __dict__ access. Only valid for types whose attribute protocol materializes the dict lazily via get_or_insert.

fn into_ref_with_type_and_dict( self, vm: &VirtualMachine, cls: PyTypeRef, eager_dict: bool, ) -> PyResult<PyRef<Self>>

where Self: Debug,

impl Representable for PyList

fn repr(zelf: &Py<Self>, vm: &VirtualMachine) -> PyResult<PyRef<PyStr>>

fn repr_str(_zelf: &Py<Self>, _vm: &VirtualMachine) -> PyResult<String>

fn slot_repr(zelf: &PyObject, vm: &VirtualMachine) -> PyResult<PyRef<PyStr>>

fn repr_wtf8(zelf: &Py<Self>, vm: &VirtualMachine) -> PyResult<Wtf8Buf>

const __OWN_METHOD_DEFS: &'static [PyMethodDef] = _

fn __extend_py_class(ctx: &'static Context, class: &'static Py<PyType>)

fn __extend_slots(slots: &mut PyTypeSlots)

impl StaticType for PyList

fn static_cell() -> &'static StaticCell<PyTypeRef>

fn static_metaclass() -> &'static Py<PyType>

fn static_baseclass() -> &'static Py<PyType>

fn static_type() -> &'static Py<PyType>

fn init_manually(typ: PyTypeRef) -> &'static Py<PyType>

fn init_builtin_type() -> &'static Py<PyType>

where Self: PyClassImpl,

fn create_static_type() -> PyTypeRef

where Self: PyClassImpl,

impl Traverse for PyList

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

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

fn clear(&mut self, out: &mut Vec<PyObjectRef>)

Extract all owned child PyObjectRefs for circular reference resolution (tp_clear). Called just before object deallocation to break circular references. Default implementation does nothing.