#include <struct.h>
Public Member Functions | |
| Struct () | |
| ~Struct () override | |
| Struct (const Struct &) | |
| Struct (Struct &&) | |
| Struct & | operator= (const Struct &) |
| Struct & | operator= (Struct &&) |
| bool | TryConvert (Handle< JsValue > value) override |
| ReturnVal< JsValue > | ToJsValue () const override |
| void | Trace (memory::HeapTracer *tracer) const override |
 Public Member Functions inherited from shaka::GenericConverter | |
| virtual | ~GenericConverter () |
| Public Member Functions inherited from shaka::memory::Traceable | |
| virtual | ~Traceable () |
| virtual bool | IsRootedAlive () const |
| virtual bool | IsShortLived () const |
Protected Member Functions | |
| template<typename Parent , typename Field > | |
| Field | CreateFieldConverter (const std::string &name, Field Parent::*field) |
Additional Inherited Members | |
| Static Public Attributes inherited from shaka::memory::Traceable | |
| static constexpr const uint64_t | kShortLiveDurationMs = 5000 |
Detailed Description
Defines the base class for struct objects. These are JavaScript objects that have specific members. Passing in any JavaScript object is valid and the respective members will be converted. Any extra members will not be copied.
This is a forgiving type, namely it will try to convert each field if possible. If it is not possible, the field will be the default. However, if the argument is not an object, it is invalid. This is non-nullable, so to accept null, use optional<Struct>.
In addition to deriving from this type, a Struct must also have a static |name| method. This is similar to BackingObjects, but you should NOT use DECLARE_TYPE_INFO. It is required to have a default (argument-less) constructor which can be implicit or user defined. If it is defined you CANNOT have member initialization (field assignments before the '{'), you MUST use assignment within the constructor body, otherwise the field will not be registered (see the macro above).
This stores the original JavaScript object this came from. ToJsValue will return that if this came from JavaScript; otherwise this creates a new JavaScript object to return. Any fields that are changed in C++ will be updated when returned back to JavaScript.
Constructor & Destructor Documentation
§ Struct() [1/3]
§ ~Struct()
§ Struct() [2/3]
|
default |
§ Struct() [3/3]
|
default |
Member Function Documentation
§ CreateFieldConverter()
|
inlineprotected |
§ operator=() [1/2]
§ operator=() [2/2]
§ ToJsValue()
|
overridevirtual |
Converts the current value into a JavaScript value.
Implements shaka::GenericConverter.
§ Trace()
|
overridevirtual |
Called during a GC run. This should call HeapTracer::Trace on all Traceable members. Be sure to call the base method when overriding.
Implements shaka::memory::Traceable.
§ TryConvert()
|
overridevirtual |
Tries to convert the given value into the required type, populating the members of this object as needed.
- Returns
- True on success, false on error.
Implements shaka::GenericConverter.
The documentation for this class was generated from the following files:
