[−][src]Struct gdnative::prelude::TypedArray

pub struct TypedArray<T> where
    T: Element,  { /* fields omitted */ }

A reference-counted CoW typed vector using Godot's pool allocator, generic over possible element types.

This type is CoW. The Clone implementation of this type creates a new reference without copying the contents.

When using this type, it's generally better to perform mutations in batch using write, or the append methods, as opposed to push or set, because the latter ones trigger CoW behavior each time they are called.

Implementations

`impl<T> TypedArray<T> where T: Element,` [src]

`pub fn new() -> TypedArray<T>`[src]

Creates an empty array.

`pub fn from_variant_array(array: &VariantArray<Shared>) -> TypedArray<T>`[src]

Creates from a VariantArray by making a best effort to convert each variant.

`pub fn from_vec(src: Vec<T>) -> TypedArray<T>`[src]

Creates a TypedArray moving elements from src.

`pub fn push(&mut self, val: T)`[src]

Appends an element to the end of the array.

Calling push triggers copy-on-write behavior. To insert a large number of elements, consider using resize and write.

`pub fn push_ref(&mut self, val: &T)`[src]

Appends an element to the end of the array by reference.

Calling push triggers copy-on-write behavior. To insert a large number of elements, consider using resize and write.

`pub fn append(&mut self, src: &TypedArray<T>)`[src]

Copies and appends all values in src to the end of the array.

`pub fn append_vec(&mut self, src: &mut Vec<T>)`[src]

Moves all the elements from src into self, leaving src empty.

Panics

If the resulting length would not fit in i32.

`pub fn insert(&mut self, offset: i32, val: T) -> bool`[src]

Inserts an element at the given offset and returns true if successful.

`pub fn insert_ref(&mut self, offset: i32, val: &T) -> bool`[src]

Inserts an element by reference at the given offset and returns true if successful.

`pub fn invert(&mut self)`[src]

Inverts the order of the elements in the array.

`pub fn remove(&mut self, idx: i32)`[src]

Removes an element at the given offset.

`pub fn resize(&mut self, size: i32)`[src]

Changes the size of the array, possibly removing elements or pushing default values.

`pub fn get(&self, idx: i32) -> T`[src]

Returns a copy of the element at the given offset.

`pub fn set(&mut self, idx: i32, val: T)`[src]

Sets the value of the element at the given offset.

`pub fn set_ref(&mut self, idx: i32, val: &T)`[src]

Sets the value of the element at the given offset by reference.

`pub fn len(&self) -> i32`[src]

Returns the number of elements in the array.

`pub fn is_empty(&self) -> bool`[src]

Returns true if the container is empty.

`pub fn read(&self) -> Aligned<ReadGuard<'_, T>>`[src]

Returns a RAII read access into this array.

`pub fn write(&mut self) -> Aligned<WriteGuard<'_, T>>`[src]

Returns a RAII write access into this array. This triggers CoW once per lock, instead of once each mutation.

`impl<T> TypedArray<T> where T: Element + Copy,` [src]

`pub fn from_slice(src: &[T]) -> TypedArray<T>`[src]

Creates a new TypedArray by copying from src.

Panics

If the length of src does not fit in i32.

`pub fn append_slice(&mut self, src: &[T])`[src]

Copies and appends all values in src to the end of the array.

Panics

If the resulting length would not fit in i32.

Trait Implementations

`impl<T> Clone for TypedArray<T> where T: Element,` [src]

`fn clone(&self) -> TypedArray<T>`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl<T> Debug for TypedArray<T> where T: Element + Debug,` [src]

`fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

`impl<T> Default for TypedArray<T> where T: Element,` [src]

`fn default() -> TypedArray<T>`[src]

`impl<T> Drop for TypedArray<T> where T: Element,` [src]