Struct runestick::Object

#[repr(transparent)]
pub struct Object { /* fields omitted */ }

Struct representing a dynamic anonymous object.

Examples

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

object.insert_value(String::from("foo"), 42)?;
object.insert_value(String::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.

pub fn with_capacity(_cap: usize) -> Self

Construct a new object with the given capacity.

pub fn len(&self) -> usize

Returns the number of elements in the object.

pub fn is_empty(&self) -> bool

Returns true if the Object contains no elements.

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

Returns a reference to the value corresponding to the key.

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

Get the given value at the given index.

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

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

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

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

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

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

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) -> Option<Value>

Inserts a key-value pair into the dynamic object.

pub fn clear(&mut self)

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

pub fn into_inner(self) -> BTreeMap<String, Value>

Convert into inner.

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 into_iterator(&self) -> Iterator

Convert into a runestick iterator.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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 From<Object> for Value

fn from(value: Object) -> Self

Performs the conversion.

impl FromIterator<(String, Value)> for Object

fn from_iter<T: IntoIterator<Item = (String, Value)>>(src: T) -> Self

Creates a value from an iterator.

impl FromValue for Object

fn from_value(value: Value) -> Result<Self, VmError>

Try to convert to the given type, from the given value.

impl InstallWith for Object

fn install_with(_: &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 Named for Object

const BASE_NAME: RawStr

The generic name of the named thing.

fn full_name() -> String

The exact type name

impl ToValue for Object

fn to_value(self) -> Result<Value, VmError>

Convert into a value.

impl TypeOf for Object

fn type_hash() -> Hash

Convert into a type hash.

fn type_info() -> TypeInfo

Access diagnostical information on the value type.

impl UnsafeFromValue for &Object

type Output = *const Object

The output type from the unsafe coercion.

type Guard = RawRef

The raw guard returned.

fn from_value(value: Value) -> Result<(Self::Output, Self::Guard), VmError>

Convert the given reference using unsafe assumptions to a value.

unsafe fn unsafe_coerce(output: Self::Output) -> Self

Coerce the output of an unsafe from value into the final output type.

impl UnsafeFromValue for &mut Object

type Output = *mut Object

The output type from the unsafe coercion.

type Guard = RawMut

The raw guard returned.

fn from_value(value: Value) -> Result<(Self::Output, Self::Guard), VmError>

Convert the given reference using unsafe assumptions to a value.

unsafe fn unsafe_coerce(output: Self::Output) -> Self

Coerce the output of an unsafe from value into the final output type.