Struct PropOptions

pub struct PropOptions<'a, 'cx, O, K>
where
    O: Object,
    K: PropertyKey,
    'cx: 'a,
{ /* private fields */ }

A builder for accessing an object property.

The builder methods make it convenient to get and set properties as well as to bind and call methods.

let x: f64 = obj
    .prop(&mut cx, "x")
    .get()?;

obj.prop(&mut cx, "y")
    .set(x)?;

let s: String = obj.method(&mut cx, "toString")?.call()?;

Implementations

impl<'a, 'cx, O, K> PropOptions<'a, 'cx, O, K>

where O: Object, K: PropertyKey, 'cx: 'a,

pub fn this(&self) -> Handle<'cx, O>

Returns the original object from which the property was accessed.

pub fn prop(&mut self, key: K) -> &mut Self

Updates the property key.

This method is useful for chaining multiple property assignments:

let obj = cx.empty_object()
    .prop(&mut cx, "x")
    .set(1)?
    .prop("y")
    .set(2)?
    .prop("color")
    .set("blue")?
    .this();

pub fn get<R: TryFromJs<'cx>>(&mut self) -> NeonResult<R>

Gets the property from the object and attempts to convert it to a Rust value.

May throw an exception either during accessing the property or converting the result type.

pub fn set<V: TryIntoJs<'cx>>(&mut self, v: V) -> NeonResult<&mut Self>

Sets the property on the object to a value converted from Rust.

May throw an exception either during converting the value or setting the property.

pub fn set_with<R, F>(&mut self, f: F) -> NeonResult<&mut Self>

where R: TryIntoJs<'cx>, F: FnOnce(&mut Cx<'cx>) -> R,

Sets the property on the object to a value computed from a closure.

May throw an exception either during converting the value or setting the property.

pub fn bind(&'a mut self) -> NeonResult<BindOptions<'a, 'cx>>

Gets the property from the object as a method and binds this to the object.

May throw an exception when accessing the property.

Defers checking that the method is callable until call time.