V8 API Reference, 7.2.502.16 (for Deno 0.2.4)
v8::ScriptCompiler::ExternalSourceStream Class Referenceabstract

#include <v8.h>

Inheritance diagram for v8::ScriptCompiler::ExternalSourceStream:
v8::DummySourceStream

Public Member Functions

virtual size_t GetMoreData (const uint8_t **src)=0
 
virtual bool SetBookmark ()
 
virtual void ResetToBookmark ()
 

Detailed Description

For streaming incomplete script data to V8. The embedder should implement a subclass of this class.

Definition at line 1337 of file v8.h.

Member Function Documentation

◆ GetMoreData()

virtual size_t v8::ScriptCompiler::ExternalSourceStream::GetMoreData ( const uint8_t **  src)
pure virtual

V8 calls this to request the next chunk of data from the embedder. This function will be called on a background thread, so it's OK to block and wait for the data, if the embedder doesn't have data yet. Returns the length of the data returned. When the data ends, GetMoreData should return 0. Caller takes ownership of the data.

When streaming UTF-8 data, V8 handles multi-byte characters split between two data chunks, but doesn't handle multi-byte characters split between more than two data chunks. The embedder can avoid this problem by always returning at least 2 bytes of data.

When streaming UTF-16 data, V8 does not handle characters split between two data chunks. The embedder has to make sure that chunks have an even length.

If the embedder wants to cancel the streaming, they should make the next GetMoreData call return 0. V8 will interpret it as end of data (and most probably, parsing will fail). The streaming task will return as soon as V8 has parsed the data it received so far.

Implemented in v8::DummySourceStream.

◆ ResetToBookmark()

void v8::ScriptCompiler::ExternalSourceStream::ResetToBookmark ( )
virtual

V8 calls this to return to a previously set bookmark.

Definition at line 2022 of file api.cc.

◆ SetBookmark()

bool v8::ScriptCompiler::ExternalSourceStream::SetBookmark ( )
virtual

V8 calls this method to set a 'bookmark' at the current position in the source stream, for the purpose of (maybe) later calling ResetToBookmark. If ResetToBookmark is called later, then subsequent calls to GetMoreData should return the same data as they did when SetBookmark was called earlier.

The embedder may return 'false' to indicate it cannot provide this functionality.

Definition at line 2020 of file api.cc.


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