V8 API Reference Guide for node.js v0.12.15 - v0.12.17
Classes | Public Member Functions | List of all members
v8::PersistentValueMap< K, V, Traits > Class Template Reference

#include <v8-util.h>

Inheritance diagram for v8::PersistentValueMap< K, V, Traits >:
Inheritance graph
[legend]

Classes

class  PersistentValueReference
 

Public Member Functions

 PersistentValueMap (Isolate *isolate)
 
IsolateGetIsolate ()
 
size_t Size ()
 
bool IsWeak ()
 
Local< V > Get (const K &key)
 
bool Contains (const K &key)
 
bool SetReturnValue (const K &key, ReturnValue< Value > returnValue)
 
void SetReference (const K &key, const Persistent< Object > &parent)
 
UniquePersistent< V > Set (const K &key, Local< V > value)
 
UniquePersistent< V > Set (const K &key, UniquePersistent< V > value)
 
UniquePersistent< V > Remove (const K &key)
 
void Clear ()
 
PersistentValueReference GetReference (const K &key)
 
UniquePersistent< V > Set (const K &key, UniquePersistent< V > value, PersistentValueReference *reference)
 

Detailed Description

template<typename K, typename V, typename Traits>
class v8::PersistentValueMap< K, V, Traits >

A map wrapper that allows using UniquePersistent as a mapped value. C++11 embedders don't need this class, as they can use UniquePersistent directly in std containers.

The map relies on a backing map, whose type and accessors are described by the Traits class. The backing map will handle values of type PersistentContainerValue, with all conversion into and out of V8 handles being transparently handled by this class.

Member Function Documentation

template<typename K, typename V, typename Traits>
void v8::PersistentValueMap< K, V, Traits >::Clear ( )
inline

Traverses the map repeatedly, in case side effects of disposal cause insertions.

template<typename K, typename V, typename Traits>
bool v8::PersistentValueMap< K, V, Traits >::Contains ( const K &  key)
inline

Check whether a value is contained in the map.

template<typename K, typename V, typename Traits>
Local<V> v8::PersistentValueMap< K, V, Traits >::Get ( const K &  key)
inline

Get value stored in map.

template<typename K, typename V, typename Traits>
PersistentValueReference v8::PersistentValueMap< K, V, Traits >::GetReference ( const K &  key)
inline

Get a reference to a map value. This enables fast, repeated access to a value stored in the map while the map remains unchanged.

Careful: This is potentially unsafe, so please use with care. The value will become invalid if the value for this key changes in the underlying map, as a result of Set or Remove for the same key; as a result of the weak callback for the same key; or as a result of calling Clear() or destruction of the map.

template<typename K, typename V, typename Traits>
bool v8::PersistentValueMap< K, V, Traits >::IsWeak ( )
inline

Return whether the map holds weak persistents.

template<typename K, typename V, typename Traits>
UniquePersistent<V> v8::PersistentValueMap< K, V, Traits >::Remove ( const K &  key)
inline

Return value for key and remove it from the map.

template<typename K, typename V, typename Traits>
UniquePersistent<V> v8::PersistentValueMap< K, V, Traits >::Set ( const K &  key,
Local< V >  value 
)
inline

Put value into map. Depending on Traits::kIsWeak, the value will be held by the map strongly or weakly. Returns old value as UniquePersistent.

template<typename K, typename V, typename Traits>
UniquePersistent<V> v8::PersistentValueMap< K, V, Traits >::Set ( const K &  key,
UniquePersistent< V >  value 
)
inline

Put value into map, like Set(const K&, Local<V>).

template<typename K, typename V, typename Traits>
UniquePersistent<V> v8::PersistentValueMap< K, V, Traits >::Set ( const K &  key,
UniquePersistent< V >  value,
PersistentValueReference reference 
)
inline

Put a value into the map and update the reference. Restrictions of GetReference apply here as well.

template<typename K, typename V, typename Traits>
void v8::PersistentValueMap< K, V, Traits >::SetReference ( const K &  key,
const Persistent< Object > &  parent 
)
inline

Call Isolate::SetReference with the given parent and the map value.

template<typename K, typename V, typename Traits>
bool v8::PersistentValueMap< K, V, Traits >::SetReturnValue ( const K &  key,
ReturnValue< Value returnValue 
)
inline

Get value stored in map and set it in returnValue. Return true if a value was found.

template<typename K, typename V, typename Traits>
size_t v8::PersistentValueMap< K, V, Traits >::Size ( )
inline

Return size of the map.


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