Struct gdnative_core::StringArray

pub struct StringArray(_);

A vector of GodotString that uses Godot's pool allocator.

Implementations

impl StringArray

pub fn new() -> Self

Creates an empty StringArray.

pub fn from_variant_array(array: &VariantArray) -> Self

Creates an array by trying to convert each variant.

See Variant::to_string_array.

pub fn push(&mut self, s: &GodotString)

Appends an element at the end of the array.

pub fn push_string_array(&mut self, strings: &StringArray)

Appends a StringArray at the end of this array.

pub fn insert(&mut self, offset: i32, string: &GodotString) -> bool

Insert a new GodotString at a given position in the array.

pub fn invert(&mut self)

Inverts the order of the elements in the array.

pub fn remove(&mut self, idx: i32)

Removes an element at the given offset.

pub fn resize(&mut self, size: i32)

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

pub fn get(&self, idx: i32) -> GodotString

Returns a copy of the element at the given offset.

pub fn set(&mut self, idx: i32, string: &GodotString)

Sets the value of the element at the given offset.

pub fn len(&self) -> i32

Returns the number of elements in the array.

pub fn read(&self) -> Aligned<ReadGuard<'a>>

pub fn write(&mut self) -> Aligned<WriteGuard<'a>>

pub fn new_ref(&self) -> StringArray

Creates a new reference to this reference-counted instance.

Trait Implementations

impl Debug for StringArray

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

Formats the value using the given formatter.

impl Default for StringArray

fn default() -> Self

Returns the "default value" for a type.

impl Drop for StringArray

fn drop(&mut self)

Executes the destructor for this type.

impl Export for StringArray

type Hint = ()

A type-specific hint type that is valid for the type being exported.

fn export_info(_hint: Option<Self::Hint>) -> ExportInfo

Returns ExportInfo given an optional typed hint.

impl FromVariant for StringArray

fn from_variant(variant: &Variant) -> Result<Self, FromVariantError>

impl ToVariant for StringArray

fn to_variant(&self) -> Variant