Struct Dictionary 

pub struct Dictionary(/* private fields */);

A reference-counted Dictionary of Variant key-value pairs.

Implementations

impl Dictionary

pub fn new() -> Dictionary

Creates an empty Dictionary.

pub fn is_empty(&self) -> bool

Returns true if the Dictionary contains no elements.

pub fn len(&self) -> i32

Returns the number of elements in the Dictionary.

pub fn clear(&mut self)

Clears the Dictionary, removing all key-value pairs.

pub fn contains(&self, key: &Variant) -> bool

Returns true if the Dictionary contains the specified key.

pub fn contains_all(&self, keys: &VariantArray) -> bool

Returns true if the Dictionary has all of the keys in the given array.

pub fn erase(&mut self, key: &Variant)

Erase a key-value pair in the Dictionary by the specified key.

pub fn get(&self, key: &Variant) -> Variant

Returns a copy of the value corresponding to the key.

pub fn set(&mut self, key: &Variant, val: &Variant)

Sets a value to the element corresponding to the key.

pub fn get_ref(&self, key: &Variant) -> &Variant

Returns a reference to the value corresponding to the key.

pub fn get_mut_ref(&mut self, key: &Variant) -> &mut Variant

Returns a mutable reference to the value corresponding to the key.

pub fn to_json(&self) -> GodotString

Returns a GodotString of the Dictionary.

pub fn keys(&self) -> VariantArray

Returns an array of the keys in the Dictionary.

pub fn values(&self) -> VariantArray

Returns an array of the values in the Dictionary.

pub fn get_next(&self, key: &Variant) -> &Variant

pub fn hash(&self) -> i32

Return a hashed i32 value representing the dictionary’s contents.

pub fn new_ref(&self) -> Dictionary

Trait Implementations

impl Debug for Dictionary

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

Formats the value using the given formatter.

impl Default for Dictionary

fn default() -> Dictionary

Returns the “default value” for a type.

impl Drop for Dictionary

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for Dictionary

impl<'l> From<&'l Dictionary> for Variant

fn from(val: &'l Dictionary) -> Variant

Converts to this type from the input type.

impl PartialEq for Dictionary

fn eq(&self, other: &Dictionary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToVariant for Dictionary

fn to_variant(&self) -> Variant

fn from_variant(variant: &Variant) -> Option<Dictionary>