Struct boa::property::Property

pub struct Property {
    pub value: Option<Value>,
    pub get: Option<Value>,
    pub set: Option<Value>,
    // some fields omitted
}

This represents a Javascript Property AKA The Property Descriptor.

Property descriptors present in objects come in two main flavors:

• data descriptors
• accessor descriptors

A data descriptor is a property that has a value, which may or may not be writable. An accessor descriptor is a property described by a getter-setter pair of functions. A descriptor must be one of these two flavors; it cannot be both.

Any field in a JavaScript Property may be present or absent.

More information:

• MDN documentation
• ECMAScript reference

Fields

value: Option<Value>

The value associated with the property

get: Option<Value>

The function serving as getter

set: Option<Value>

The function serving as setter

Implementations

impl Property

pub fn new() -> Self

Make a new property with the given value The difference between New and Default:

New: zeros everything to make an empty object Default: Defaults according to the spec

pub fn empty() -> Self

pub fn data_descriptor(value: Value, attribute: Attribute) -> Self

pub fn configurable(&self) -> bool

Get the

pub fn set_configurable(&mut self, configurable: bool)

pub fn configurable_or(&self, value: bool) -> bool

pub fn enumerable(&self) -> bool

Set enumerable

pub fn enumerable_or(&self, value: bool) -> bool

pub fn writable(&self) -> bool

Set writable

pub fn writable_or(&self, value: bool) -> bool

pub fn value(self, value: Value) -> Self

Set value

pub fn get(self, get: Value) -> Self

Set get

pub fn has_get(&self) -> bool

pub fn set(self, set: Value) -> Self

Set set

pub fn has_set(&self) -> bool

pub fn is_none(&self) -> bool

Is this an empty Property?

true if all fields are set to none

pub fn is_accessor_descriptor(&self) -> bool

An accessor Property Descriptor is one that includes any fields named either [[Get]] or [[Set]].

More information:

• ECMAScript reference

pub fn is_data_descriptor(&self) -> bool

A data Property Descriptor is one that includes any fields named either [Value] or [[Writable]].

More information:

• ECMAScript reference

pub fn is_generic_descriptor(&self) -> bool

Check if a property is generic descriptor.

More information:

• ECMAScript reference

Trait Implementations

impl Clone for Property

fn clone(&self) -> Property

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Property

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

Formats the value using the given formatter.

impl Default for Property

fn default() -> Self

Make a default property

More information:

• ECMAScript reference

impl Drop for Property

fn drop(&mut self)

Executes the destructor for this type.

impl Finalize for Property

fn finalize(&self)

impl<'_> From<&'_ Property> for Value

fn from(value: &Property) -> Value

Performs the conversion.

impl<'a> From<&'a Value> for Property

fn from(value: &Value) -> Self

Attempt to fetch values "configurable", "enumerable", "writable" from the value, if they're not there default to false

impl Trace for Property

unsafe fn trace(&self)

Marks all contained Gcs.

unsafe fn root(&self)

Increments the root-count of all contained Gcs.

unsafe fn unroot(&self)

Decrements the root-count of all contained Gcs.

fn finalize_glue(&self)

Runs Finalize::finalize() on this object and all contained subobjects