Struct Symbol

Source

pub struct Symbol { /* private fields */ }

Expand description

JavaScript Symbol type.

Symbols are a primitive data type in JavaScript that are guaranteed to be unique. They are often used as object keys to avoid naming collisions.

Implementations§

Source §

impl Symbol

Source

pub fn new(description: Option<String>) -> Self

Creates a new Symbol with an optional description.

§Arguments

description - Optional description for the symbol

§Examples

use jsbind::prelude::*;

let sym1 = Symbol::new(None);
let sym2 = Symbol::new(Some("my symbol"));

Source

pub fn for_key(key: &str) -> Self

Creates a symbol from the global Symbol registry.

§Arguments

key - The key to lookup/register in the global symbol registry

§Returns

The symbol associated with the key

§Examples

use jsbind::prelude::*;

let sym1 = Symbol::for_key("myKey");
let sym2 = Symbol::for_key("myKey");
// sym1 and sym2 refer to the same symbol

Source

pub fn key_for(&self) -> Option<String>

Gets the key for this symbol from the global symbol registry.

§Returns

The key if this symbol is in the global registry, None otherwise

§Examples

use jsbind::prelude::*;

let sym = Symbol::for_key("myKey");
assert_eq!(sym.key_for(), Some("myKey".to_string()));

let local_sym = Symbol::new(None);
assert_eq!(local_sym.key_for(), None);

Source

pub fn description(&self) -> Option<String>

Gets the description of this symbol.

§Returns

The description if available

§Examples

use jsbind::prelude::*;

let sym = Symbol::new(Some("test symbol"));
assert_eq!(sym.description(), Some("test symbol".to_string()));

Source

pub fn to_string_repr(&self) -> String

Returns the string representation of this symbol.

§Returns

String representation like “Symbol(description)”

§Examples

use jsbind::prelude::*;

let sym = Symbol::new(Some("test"));
let str_repr = sym.to_string_repr();
// str_repr will be something like "Symbol(test)"

Source

pub fn value_of(&self) -> String

Gets primitive symbol value as string.

§Returns

String representation of the symbol

§Examples

use jsbind::prelude::*;

let sym = Symbol::new(Some("test"));
let value = sym.value_of();

Source

pub fn is_empty(&self) -> bool

Checks if symbol has no description.

§Returns

true if description is undefined

§Examples

use jsbind::prelude::*;

let sym1 = Symbol::new(None);
assert!(sym1.is_empty());

let sym2 = Symbol::new(Some("test"));
assert!(!sym2.is_empty());

Source

pub fn get_hash(&self) -> u64

Gets hash code for symbol.

§Returns

Hash value based on unique handle

§Examples

use jsbind::prelude::*;

let sym = Symbol::new(Some("test"));
let hash_val = sym.get_hash();

Source

pub fn async_iterator() -> Self

Symbol.asyncIterator

Source

pub fn has_instance() -> Self

Symbol.hasInstance

Source

pub fn is_concat_spreadable() -> Self

Symbol.isConcatSpreadable

Source

pub fn iterator() -> Self

Symbol.iterator

Source

pub fn match_() -> Self

Symbol.match

Source

pub fn match_all() -> Self

Symbol.matchAll

Source

pub fn replace() -> Self

Symbol.replace

Source

pub fn search() -> Self

Symbol.search

Source

pub fn species() -> Self

Symbol.species

Source

pub fn split() -> Self

Symbol.split

Source

pub fn to_primitive() -> Self

Symbol.toPrimitive

Source

pub fn to_string_tag() -> Self

Symbol.toStringTag

Source

pub fn unscopables() -> Self

Symbol.unscopables

Methods from Deref<Target = Any>§

Source

pub fn get<T>(&self, prop: T) -> Val
where T: Into<Val>,

Gets the property prop

Source

pub fn set<K, V>(&self, prop: K, val: V)
where K: Into<Val>, V: Into<Val>,

Set the underlying js object property prop to val

Source

pub fn has<T>(&self, prop: T) -> bool
where T: Into<Val>,

Checks whether a property prop exists

Source

pub fn has_own_property(&self, prop: &str) -> bool

Checks whether a non-inherited property prop exists

Source

pub fn type_of(&self) -> String

Gets the typeof the underlying js object

Source

pub fn at<T>(&self, idx: T) -> Val
where T: Into<Val>,

Gets the element at index idx. Assumes the underlying js type is indexable

Source

pub fn to_vec<V>(&self) -> Vec<V>
where V: FromVal,

Converts the underlying js array to a Vec of V

Source

pub fn call(&self, f: &str, args: &[Val]) -> Val

Calls the method f with args, can return an undefined js value

Source

pub fn new(&self, args: &[Val]) -> Val

Calls the object’s constructor with args constructing a new object

Source

pub fn invoke(&self, args: &[Val]) -> Val

Invokes the function object with args, can return an undefined js value

Source

pub fn await_(&self) -> Val

Awaits the invoked function object

Source

pub fn instanceof(&self, v: Val) -> bool

Checks whether this Val is an instanceof v

Source

pub fn as_<T>(&self) -> T
where T: FromVal,

Examples found in repository ?

examples/any.rs (line 15)

3fn main() {
4    emlite::init();
5    // Create Any from different Rust types
6    let num = Any::from(123);
7    let text = Any::from("hello");
8    let boolean = Any::from(true);
9    println!("Any from int: {:?}", num);
10    println!("Any from str: {:?}", text);
11    println!("Any from bool: {:?}", boolean);
12    Console::get().log(&[num.clone(), text.clone(), boolean.clone()]);
13
14    // Convert Any back to Rust types using as_::<T>()
15    let n: i32 = num.as_();
16    let s: Option<String> = text.as_();
17    let b: bool = boolean.as_();
18    println!("Extracted i32: {}", n);
19    println!("Extracted String: {:?}", s);
20    println!("Extracted bool: {}", b);
21}

More examples

Hide additional examples

examples/closures.rs (line 10)

4fn main() {
5    emlite::init();
6
7    // 0-arg closure returning a number
8    let c0 = Closure::bind0(|| 42);
9    let f0: Function = (&c0).into();
10    let r0 = f0.call(&Any::undefined(), &[]).unwrap().as_::<i32>();
11    Console::get().log(&[Any::from(r0)]);
12
13    // 1-arg closure: add 1
14    let c1 = Closure::bind1(|x: i32| x + 1);
15    let f1: Function = (&c1).into();
16    let r1 = f1
17        .call(&Any::undefined(), &[Any::from(9)])
18        .unwrap()
19        .as_::<i32>();
20    Console::get().log(&[Any::from(r1)]);
21
22    // 2-arg closure: sum
23    let c2 = Closure::bind2(|a: i32, b: i32| a + b);
24    let f2: Function = (&c2).into();
25    let r2 = f2
26        .call(&Any::undefined(), &[Any::from(2), Any::from(3)])
27        .unwrap()
28        .as_::<i32>();
29    Console::get().log(&[Any::from(r2)]);
30
31    // 3-arg closure: format string
32    let c3 = Closure::bind3(|a: i32, b: i32, c: i32| format!("{}-{}-{}", a, b, c));
33    let f3: Function = (&c3).into();
34    let r3 = f3
35        .call(
36            &Any::undefined(),
37            &[Any::from(1), Any::from(2), Any::from(3)],
38        )
39        .unwrap()
40        .as_::<Option<String>>()
41        .unwrap();
42    Console::get().log(&[Any::from(r3)]);
43
44    // 4-arg closure: sum of four
45    let c4 = Closure::bind4(|a: i32, b: i32, c: i32, d: i32| a + b + c + d);
46    let f4: Function = (&c4).into();
47    let r4 = f4
48        .call(
49            &Any::undefined(),
50            &[Any::from(1), Any::from(2), Any::from(3), Any::from(4)],
51        )
52        .unwrap()
53        .as_::<i32>();
54    Console::get().log(&[Any::from(r4)]);
55}