Struct Object 

pub struct Object { /* private fields */ }

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)?;
object.insert_value(String::try_from("bar")?, true)?;
assert_eq!(2, object.len());

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

Implementations

impl Object

pub fn new() -> Self

Construct a new object.

Examples

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

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

Construct a new object with the given capacity.

Examples

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

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);

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());

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.

pub fn get_value<Q, T>(&self, k: &Q) -> Result<Option<T>, VmError>

where String: Borrow<Q>, Q: ?Sized + Hash + Eq + Ord, T: FromValue,

Get the given value at the given index.

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.

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.

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.

pub fn insert_value<T>(&mut self, k: String, v: T) -> Result<(), VmError>

where T: ToValue,

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

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.

Examples

let map = #{};
assert_eq!(map.insert("a", 1), None);
assert_eq!(map.is_empty(), false);

map.insert("b", 2);
assert_eq!(map.insert("b", 3), Some(2));
assert_eq!(map["b"], 3);

pub fn clear(&mut self)

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

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).

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

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

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

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

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).

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)]);

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"]);

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

impl Any for Object

const ANY_TYPE_INFO: AnyTypeInfo = _

The compile-time type information know for the type.

impl Debug for Object

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

Formats the value using the given formatter.

impl Default for Object

fn default() -> Object

Returns the “default value” for a type.

impl Dismantle for Object

An object is made of the values put into it, and a script can nest one inside another without any bound, so it hands over what it is made of rather than being dropped in place.

fn dismantle(&mut self, out: &mut Handover<'_>)

Hand over every value this is made of, leaving nothing behind which is itself made of values.

impl InstallWith for Object

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

Hook to install more things into the module.

impl<'a> IntoIterator for &'a Object

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

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Object

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.

type Item = (String, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, Value>

Which kind of iterator are we turning this into?

impl IntoOutput for Object

impl MaybeTypeOf for Object

fn maybe_type_of() -> Result<DocType>

Type information for the given type.

impl Named for Object

const ITEM: &'static Item

The name item.

fn full_name(f: &mut Formatter<'_>) -> Result

The full name of the type.

fn display() -> impl Display

Return a display wrapper for the full name of the type.

impl TryClone for Object

fn try_clone(&self) -> Result<Self>

Try to clone the current value, raising an allocation error if it’s unsuccessful.

fn try_clone_from(&mut self, source: &Self) -> Result<(), Error>

Performs copy-assignment from source.

impl TryFrom<Object> for Value

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TypeHash for Object

const HASH: Hash

The complete type hash of the type including type parameters which uniquely identifiers a given type.

impl TypeOf for Object

const PARAMETERS: Hash

Type parameters for the type.

const STATIC_TYPE_INFO: AnyTypeInfo = <Self as rune::Any>::ANY_TYPE_INFO

Access diagnostical type information for the current type.

fn type_info() -> TypeInfo

Get type info associated with the current type.

impl UnsafeToMut for Object

type Guard = RawValueGuard

The raw guard returned.

unsafe fn unsafe_to_mut<'a>( value: Value, ) -> Result<(&'a mut Self, Self::Guard), RuntimeError>

Safety

impl UnsafeToRef for Object

type Guard = RawValueGuard

The raw guard returned.

unsafe fn unsafe_to_ref<'a>( value: Value, ) -> Result<(&'a Self, Self::Guard), RuntimeError>

Safety

impl UnsafeToValue for &Object

type Guard = ValueRefGuard

The type used to guard the unsafe value conversion.

unsafe fn unsafe_to_value(self) -> Result<(Value, Self::Guard), RuntimeError>

Convert into a value.

impl UnsafeToValue for &mut Object

type Guard = ValueMutGuard

The type used to guard the unsafe value conversion.

unsafe fn unsafe_to_value(self) -> Result<(Value, Self::Guard), RuntimeError>

Convert into a value.