A JavaScript symbol (ECMA-262 edition 6) More...

#include <v8.h>

Inheritance diagram for v8::Symbol:

Collaboration diagram for v8::Symbol:

Public Member Functions
Local< Value >	Name () const

Public Member Functions inherited from v8::Value
bool	IsUndefined () const
	Returns true if this value is the undefined value. More...

bool	IsNull () const
	Returns true if this value is the null value. More...

bool	IsTrue () const
	Returns true if this value is true. More...

bool	IsFalse () const
	Returns true if this value is false. More...

bool	IsName () const
	Returns true if this value is a symbol or a string. More...

bool	IsString () const
	Returns true if this value is an instance of the String type. More...

bool	IsSymbol () const
	Returns true if this value is a symbol. More...

bool	IsFunction () const
	Returns true if this value is a function. More...

bool	IsArray () const
	Returns true if this value is an array. More...

bool	IsObject () const
	Returns true if this value is an object. More...

bool	IsBoolean () const
	Returns true if this value is boolean. More...

bool	IsNumber () const
	Returns true if this value is a number. More...

bool	IsExternal () const
	Returns true if this value is external. More...

bool	IsInt32 () const
	Returns true if this value is a 32-bit signed integer. More...

bool	IsUint32 () const
	Returns true if this value is a 32-bit unsigned integer. More...

bool	IsDate () const
	Returns true if this value is a Date. More...

bool	IsArgumentsObject () const
	Returns true if this value is an Arguments object. More...

bool	IsBooleanObject () const
	Returns true if this value is a Boolean object. More...

bool	IsNumberObject () const
	Returns true if this value is a Number object. More...

bool	IsStringObject () const
	Returns true if this value is a String object. More...

bool	IsSymbolObject () const
	Returns true if this value is a Symbol object. More...

bool	IsNativeError () const
	Returns true if this value is a NativeError. More...

bool	IsRegExp () const
	Returns true if this value is a RegExp. More...

bool	IsGeneratorFunction () const
	Returns true if this value is a Generator function. More...

bool	IsGeneratorObject () const
	Returns true if this value is a Generator object (iterator). More...

bool	IsPromise () const
	Returns true if this value is a Promise. More...

bool	IsMap () const
	Returns true if this value is a Map. More...

bool	IsSet () const
	Returns true if this value is a Set. More...

bool	IsWeakMap () const
	Returns true if this value is a WeakMap. More...

bool	IsWeakSet () const
	Returns true if this value is a WeakSet. More...

bool	IsArrayBuffer () const
	Returns true if this value is an ArrayBuffer. More...

bool	IsArrayBufferView () const
	Returns true if this value is an ArrayBufferView. More...

bool	IsTypedArray () const
	Returns true if this value is one of TypedArrays. More...

bool	IsUint8Array () const
	Returns true if this value is an Uint8Array. More...

bool	IsUint8ClampedArray () const
	Returns true if this value is an Uint8ClampedArray. More...

bool	IsInt8Array () const
	Returns true if this value is an Int8Array. More...

bool	IsUint16Array () const
	Returns true if this value is an Uint16Array. More...

bool	IsInt16Array () const
	Returns true if this value is an Int16Array. More...

bool	IsUint32Array () const
	Returns true if this value is an Uint32Array. More...

bool	IsInt32Array () const
	Returns true if this value is an Int32Array. More...

bool	IsFloat32Array () const
	Returns true if this value is a Float32Array. More...

bool	IsFloat64Array () const
	Returns true if this value is a Float64Array. More...

bool	IsDataView () const
	Returns true if this value is a DataView. More...

Local< Boolean >	ToBoolean () const

Local< Number >	ToNumber () const

Local< String >	ToString () const

Local< String >	ToDetailString () const

Local< Object >	ToObject () const

Local< Integer >	ToInteger () const

Local< Uint32 >	ToUint32 () const

Local< Int32 >	ToInt32 () const

Local< Uint32 >	ToArrayIndex () const
	Attempts to convert a string to an array index. More...

bool	BooleanValue () const

double	NumberValue () const

int64_t	IntegerValue () const

uint32_t	Uint32Value () const

int32_t	Int32Value () const

bool	Equals (Handle< Value > that) const
	JS ==. More...

bool	StrictEquals (Handle< Value > that) const

bool	SameValue (Handle< Value > that) const

Static Public Member Functions
static Local< Symbol >	New (Isolate *isolate, Local< String > name=Local< String >())

static Local< Symbol >	For (Isolate *isolate, Local< String > name)

static Local< Symbol >	ForApi (Isolate *isolate, Local< String > name)

static Local< Symbol >	GetIterator (Isolate *isolate)

static Local< Symbol >	GetUnscopables (Isolate *isolate)

static Symbol *	Cast (v8::Value *obj)

Static Public Member Functions inherited from v8::Name
static Name *	Cast (v8::Value *obj)

Static Public Member Functions inherited from v8::Value
template<class T >
static Value *	Cast (T *value)

Private Member Functions
	Symbol ()

Static Private Member Functions
static void	CheckCast (v8::Value *obj)

Detailed Description

A JavaScript symbol (ECMA-262 edition 6)

This is an experimental feature. Use at your own risk.

Definition at line 2099 of file v8.h.

Constructor & Destructor Documentation

◆ Symbol()

v8::Symbol::Symbol ( )

private

Member Function Documentation

◆ Cast()

Symbol * v8::Symbol::Cast ( v8::Value * obj )

inlinestatic

Definition at line 6582 of file v8.h.

                                    {
 #ifdef V8_ENABLE_CHECKS
   CheckCast(value);
 #endif
   return static_cast<Symbol*>(value);
 }

◆ CheckCast()

void v8::Symbol::CheckCast ( v8::Value * obj )

staticprivate

Definition at line 2738 of file api.cc.

                                       {
   i::Handle<i::Object> obj = Utils::OpenHandle(that);
   Utils::ApiCheck(obj->IsSymbol(),
                   "v8::Symbol::Cast()",
                   "Could not convert to symbol");
 }

References v8::Utils::ApiCheck(), and v8::Utils::OpenHandle().

Here is the call graph for this function:

◆ For()

Local< Symbol > v8::Symbol::For	(	Isolate *	isolate,
		Local< String >	name
	)

static

Definition at line 6201 of file api.cc.

                                                                 {
   i::Isolate* i_isolate = reinterpret_cast<i::Isolate*>(isolate);
   i::Handle<i::String> i_name = Utils::OpenHandle(*name);
   i::Handle<i::String> part = i_isolate->factory()->for_string();
   return Utils::ToLocal(SymbolFor(i_isolate, i_name, part));
 }

References v8::internal::Isolate::factory(), name, v8::Utils::OpenHandle(), v8::SymbolFor(), and v8::Utils::ToLocal().

Here is the call graph for this function:

◆ ForApi()

Local< Symbol > v8::Symbol::ForApi	(	Isolate *	isolate,
		Local< String >	name
	)

static

Definition at line 6209 of file api.cc.

                                                                    {
   i::Isolate* i_isolate = reinterpret_cast<i::Isolate*>(isolate);
   i::Handle<i::String> i_name = Utils::OpenHandle(*name);
   i::Handle<i::String> part = i_isolate->factory()->for_api_string();
   return Utils::ToLocal(SymbolFor(i_isolate, i_name, part));
 }

References v8::internal::Isolate::factory(), name, v8::Utils::OpenHandle(), v8::SymbolFor(), and v8::Utils::ToLocal().

Here is the call graph for this function:

◆ GetIterator()

Local< Symbol > v8::Symbol::GetIterator ( Isolate * isolate )

static

Definition at line 6226 of file api.cc.

                                                     {
   return GetWellKnownSymbol(isolate, "Symbol.iterator");
 }

References v8::GetWellKnownSymbol().

Here is the call graph for this function:

◆ GetUnscopables()

Local< Symbol > v8::Symbol::GetUnscopables ( Isolate * isolate )

static

Definition at line 6231 of file api.cc.

                                                        {
   return GetWellKnownSymbol(isolate, "Symbol.unscopables");
 }

References v8::GetWellKnownSymbol().

Here is the call graph for this function:

◆ Name()

Local< Value > v8::Symbol::Name ( ) const

Definition at line 4932 of file api.cc.

                                 {
   i::Handle<i::Symbol> sym = Utils::OpenHandle(this);
   i::Handle<i::Object> name(sym->name(), sym->GetIsolate());
   return Utils::ToLocal(name);
 }

References name, v8::Utils::OpenHandle(), and v8::Utils::ToLocal().

Here is the call graph for this function:

◆ New()

Local< Symbol > v8::Symbol::New	(	Isolate *	isolate,
		Local< String >	name = `Local<String>()`
	)

static

Definition at line 6172 of file api.cc.

                                                                 {
   i::Isolate* i_isolate = reinterpret_cast<i::Isolate*>(isolate);
   LOG_API(i_isolate, "Symbol::New()");
   ENTER_V8(i_isolate);
   i::Handle<i::Symbol> result = i_isolate->factory()->NewSymbol();
   if (!name.IsEmpty()) result->set_name(*Utils::OpenHandle(*name));
   return Utils::ToLocal(result);
 }

References ENTER_V8, v8::internal::Isolate::factory(), LOG_API, name, v8::Utils::OpenHandle(), and v8::Utils::ToLocal().

Here is the call graph for this function:

The documentation for this class was generated from the following files:

/mnt/V8SourceCode/include/v8.h
/mnt/V8SourceCode/src/api.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Symbol()

Member Function Documentation

◆ Cast()

◆ CheckCast()

◆ For()

◆ ForApi()

◆ GetIterator()

◆ GetUnscopables()

◆ Name()

◆ New()