Struct List

#[repr(C)]
pub struct List<T> { /* private fields */ }

Mutable, reference-counted sequence of T, sharing its underlying ListObj with C++. Cloning is cheap (it bumps the refcount) and yields a handle to the same list.

Implementations

impl<T: ContainerElement> List<T>

pub fn new() -> Self

Creates a new, empty list (via an ffi.List() call to the C++ runtime).

pub fn len(&self) -> usize

Returns the number of elements.

pub fn is_empty(&self) -> bool

Returns true if the list contains no elements.

pub fn capacity(&self) -> usize

Returns the number of elements the buffer holds before it is reallocated.

pub fn get(&self, index: usize) -> Result<T>

Returns the element at index.

pub fn set(&self, index: usize, value: T) -> Result<()>

Replaces the element at index.

pub fn push(&self, value: T) -> Result<()>

Appends value to the end of the list.

pub fn insert(&self, index: usize, value: T) -> Result<()>

Inserts value at index, shifting the elements after it.

pub fn remove(&self, index: usize) -> Result<T>

Removes and returns the element at index, shifting the elements after it. If that element is not a T, the list is left untouched.

pub fn clear(&self)

Removes all elements, keeping the buffer.

pub fn first(&self) -> Result<T>

Returns the first element, or an INDEX_ERROR if the list is empty.

pub fn last(&self) -> Result<T>

Returns the last element, or an INDEX_ERROR if the list is empty.

pub fn pop(&self) -> Result<T>

Removes and returns the last element, or an INDEX_ERROR if the list is empty.

pub fn truncate(&self, len: usize)

Shortens the list to len elements, dropping the rest; a no-op when it is already that short. C++ resize when shrinking.

pub fn remove_range(&self, start: usize, end: usize) -> Result<()>

Removes the elements in start..end, shifting the ones after them.

pub fn insert_many<I: IntoIterator<Item = T>>( &self, index: usize, iter: I, ) -> Result<()>

Inserts every item of iter, in order, at index, shifting the elements after it. C++ insert(position, first, last).

pub fn reserve(&self, additional: usize) -> Result<()>

Makes room for at least additional more elements without reallocating again, like Vec::reserve. C++ reserve(n) takes the absolute capacity instead.

pub fn extend<I: IntoIterator<Item = T>>(&self, iter: I) -> Result<()>

Appends every item of iter, in order.

pub fn resize(&self, new_len: usize, value: T) -> Result<()>

where T: Clone,

Resizes the list to new_len elements, dropping the tail or appending clones of value. C++ resize.

pub fn reverse(&self)

Reverses the elements in place. C++ Reverse.

pub fn iter(&self) -> ListIterator<'_, T>

Returns a double-ended iterator over the elements, yielding Result<T>; see ListIterator.

Trait Implementations

impl<T: ContainerElement> AnyCompatible for List<T>

unsafe fn is_undefined(field: *const Self) -> bool

Whether field, which holds a value of this type or all-zero bytes, holds all-zero bytes that are no value of this type, as a null object reference, a string of type index None or a zero device type: a field that a creator left undefined for reflection to set, as C++ UnsafeInit leaves a reference undefined (null). Unlike a C++ undefined reference, it is no value; a nullable reference is Option<T>, whose None is a defined value.

fn type_str() -> String

the type string of the type

fn type_schema() -> String

The type schema of the type: the JSON object C++ TypeTraits<T>::TypeSchema writes, which the type schemas of functions and fields embed.

unsafe fn check_any_strict(data: &TVMFFIAny) -> bool

unsafe fn copy_to_any_view(src: &Self, data: &mut TVMFFIAny)

the value to copy to TVMFFIAny

unsafe fn move_to_any(src: Self, data: &mut TVMFFIAny)

consume the value to move to Any

unsafe fn copy_from_any_view_after_check(data: &TVMFFIAny) -> Self

Copy value from TVMFFIAny after checking caller must ensure that the value is compatible with the type

unsafe fn move_from_any_after_check(data: &mut TVMFFIAny) -> Self

the value to move from TVMFFIAny NOTE: pay very careful attention to avoid memory leak!

unsafe fn try_cast_from_any_view(data: &TVMFFIAny) -> Result<Self, ()>

try to cast the value from AnyView

fn get_mismatch_type_info(data: &TVMFFIAny) -> String

Get the type key of a type when TryCastFromAnyView fails.

fn to_any(&self) -> Any

Borrow self into an owned Any, increfing object-backed values.

impl<T: ContainerElement> ArgIntoRef for &List<T>

type Target = List<T>

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

impl<T: ContainerElement> ArgIntoRef for List<T>

type Target = List<T>

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

impl<T> Clone for List<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for List<T>

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

Formats the value using the given formatter.

impl<T: ContainerElement> Default for List<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ContainerElement> FromIterator<T> for List<T>

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

Creates a value from an iterator.

impl<'a, T: ContainerElement> IntoArgHolder for &'a List<T>

type Target = &'a List<T>

fn into_arg_holder(self) -> Self::Target

impl<T: ContainerElement> IntoArgHolder for List<T>

type Target = List<T>

fn into_arg_holder(self) -> Self::Target

impl<'a, T: ContainerElement> IntoIterator for &'a List<T>

type Item = Result<T, Error>

The type of the elements being iterated over.

type IntoIter = ListIterator<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> ObjectRefCore for List<T>

type ContainerType = ListObj

fn data(this: &Self) -> &ObjectArc<ListObj>

fn into_data(this: Self) -> ObjectArc<ListObj>

unsafe fn from_data(data: ObjectArc<ListObj>) -> Self

Construct a reference view from an owning container handle.

fn same_as<Other: ObjectRefCore>(&self, other: &Other) -> bool

Return whether two object references point to the same allocation.

fn downcast_ref<T: ObjectCore>(&self) -> Option<&T>

Borrow the underlying object as T when its runtime type is T or a subtype.

impl<T: ContainerElement> TryFrom<Any> for List<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Any) -> Result<Self>

Performs the conversion.

impl<'a, T: ContainerElement> TryFrom<AnyView<'a>> for List<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AnyView<'a>) -> Result<Self>

Performs the conversion.