Struct Object

Source

pub struct Object { /* private fields */ }

Expand description

Struct representing a dynamic anonymous object.

§Rust Examples

use rune::alloc::String;

let mut object = rune::runtime::Object::new();
assert!(object.is_empty());

object.insert_value(String::try_from("foo")?, 42).into_result()?;
object.insert_value(String::try_from("bar")?, true).into_result()?;
assert_eq!(2, object.len());

assert_eq!(Some(42), object.get_value("foo").into_result()?);
assert_eq!(Some(true), object.get_value("bar").into_result()?);
assert_eq!(None::<bool>, object.get_value("baz").into_result()?);

Implementations§

Source §

impl Object

Source

pub fn new() -> Self

Construct a new object.

§Examples

let object = Object::new();
object.insert("Hello", "World");

Source

pub fn with_capacity(capacity: usize) -> Result<Self>

Construct a new object with the given capacity.

Source

pub fn len(&self) -> usize

Returns the number of elements in the object.

§Examples

let object = Object::with_capacity(16);
object.insert("Hello", "World");
assert_eq!(object.len(), 1);

Source

pub fn is_empty(&self) -> bool

Returns true if the object is empty.

§Examples

let object = Object::with_capacity(16);
assert!(object.is_empty());
object.insert("Hello", "World");
assert!(!object.is_empty());

Source

pub fn get<Q>(&self, k: &Q) -> Option<&Value>
where String: Borrow<Q>, Q: ?Sized + Hash + Eq + Ord,

Returns a reference to the value corresponding to the key.

Source

pub fn get_value<Q, T>(&self, k: &Q) -> VmResult<Option<T>>
where String: Borrow<Q>, Q: ?Sized + Hash + Eq + Ord, T: FromValue,

Get the given value at the given index.

Source

pub fn get_mut<Q>(&mut self, k: &Q) -> Option<&mut Value>
where String: Borrow<Q>, Q: ?Sized + Hash + Eq + Ord,

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

Source

pub fn contains_key<Q>(&self, k: &Q) -> bool
where String: Borrow<Q>, Q: ?Sized + Hash + Eq + Ord,

Returns true if the map contains a value for the specified key.

Source

pub fn remove<Q>(&mut self, k: &Q) -> Option<Value>
where String: Borrow<Q>, Q: ?Sized + Hash + Eq + Ord,

Removes a key from the map, returning the value at the key if the key was previously in the map.

Source

pub fn insert_value<T>(&mut self, k: String, v: T) -> VmResult<()>
where T: ToValue,

Inserts a key-value pair into the dynamic object, converting it as necessary through the ToValue trait.

Source

pub fn insert(&mut self, k: String, v: Value) -> Result<Option<Value>>

Inserts a key-value pair into the map.

If the map did not have this key present, None is returned.

Source

pub fn clear(&mut self)

Clears the object, removing all key-value pairs. Keeps the allocated memory for reuse.

Source

pub fn iter(&self) -> Iter<'_, String, Value>

An iterator visiting all key-value pairs in arbitrary order. The iterator element type is (&'a String, &'a Value).

Source

pub fn keys(&self) -> Keys<'_, String, Value>

An iterator visiting all keys in arbitrary order. The iterator element type is &'a String.

Source

pub fn values(&self) -> Values<'_, String, Value>

An iterator visiting all values in arbitrary order. The iterator element type is &'a Value.

Source

pub fn iter_mut(&mut self) -> IterMut<'_, String, Value>

An iterator visiting all key-value pairs in arbitrary order, with mutable references to the values.

The iterator element type is (&'a String, &'a mut Value).

Source

pub fn rune_iter(this: Ref<Self>) -> RuneIter

An iterator visiting all keys and values in arbitrary order.

§Examples

let object = #{a: 1, b: 2, c: 3};
let vec = [];

for key in object.iter() {
    vec.push(key);
}

vec.sort_by(|a, b| a.0.cmp(b.0));
assert_eq!(vec, [("a", 1), ("b", 2), ("c", 3)]);

Source

pub fn rune_keys(this: Ref<Self>) -> RuneIterKeys

An iterator visiting all keys in arbitrary order.

§Examples

let object = #{a: 1, b: 2, c: 3};
let vec = [];

for key in object.keys() {
    vec.push(key);
}

vec.sort_by(|a, b| a.cmp(b));
assert_eq!(vec, ["a", "b", "c"]);

Source

pub fn rune_values(this: Ref<Self>) -> RuneValues

An iterator visiting all values in arbitrary order.

§Examples

let object = #{a: 1, b: 2, c: 3};
let vec = [];

for key in object.values() {
    vec.push(key);
}

vec.sort_by(|a, b| a.cmp(b));
assert_eq!(vec, [1, 2, 3]);

Trait Implementations§

Source §

impl Any for Object

Source §

const ANY_TYPE_INFO: AnyTypeInfo = _

The compile-time type information know for the type.

Source §

impl Debug for Object

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Object

Source §

fn default() -> Object

Returns the “default value” for a type. Read more

Source §

impl InstallWith for Object

Source §

fn install_with(module: &mut Module) -> Result<(), ContextError>

Hook to install more things into the module.

Source §

impl<'a> IntoIterator for &'a Object

Source §

type Item = (&'a String, &'a Value)

The type of the elements being iterated over.

Source §

type IntoIter = Iter<'a, String, Value>

Which kind of iterator are we turning this into?

Source §

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Source §

impl<'a> IntoIterator for &'a mut Object

Source §

type Item = (&'a String, &'a mut Value)

The type of the elements being iterated over.

Source §

type IntoIter = IterMut<'a, String, Value>

Which kind of iterator are we turning this into?

Source §

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Source §

impl IntoIterator for Object

Source §

fn into_iter(self) -> Self::IntoIter

Creates a consuming iterator, that is, one that moves each key-value pair out of the object in arbitrary order. The object cannot be used after calling this.

Source §