 |
v8
8.6.395 (node 15.0.1)
V8 is Google's open source JavaScript engine
|
|
v8
8.6.395 (node 15.0.1)
V8 is Google's open source JavaScript engine
|
#include <v8.h>
Data Structures | |
| class | ExternalOneByteStringResource |
| class | ExternalStringResource |
| class | ExternalStringResourceBase |
| class | Utf8Value |
| class | Value |
Public Types | |
| enum | Encoding { UNKNOWN_ENCODING = 0x1 , TWO_BYTE_ENCODING = 0x0 , ONE_BYTE_ENCODING = 0x8 } |
| enum | WriteOptions { NO_OPTIONS = 0 , HINT_MANY_WRITES_EXPECTED = 1 , NO_NULL_TERMINATION = 2 , PRESERVE_ONE_BYTE_NULL = 4 , REPLACE_INVALID_UTF8 = 8 } |
Static Public Attributes | |
| static constexpr int | kMaxLength |
| enum Encoding |
| enum WriteOptions |
Write the contents of the string to an external buffer. If no arguments are given, expects the buffer to be large enough to hold the entire string and NULL terminator. Copies the contents of the string and the NULL terminator into the buffer.
WriteUtf8 will not write partial UTF-8 sequences, preferring to stop before the end of the buffer.
Copies up to length characters into the output buffer. Only null-terminates if there is enough space in the buffer.
| buffer | The buffer into which the string will be copied. |
| start | The starting position within the string at which copying begins. |
| length | The number of characters to copy from the string. For WriteUtf8 the number of bytes in the buffer. |
| nchars_ref | The number of characters written, can be NULL. |
| options | Various options that might affect performance of this or subsequent operations. |
| Enumerator | |
|---|---|
| NO_OPTIONS | |
| HINT_MANY_WRITES_EXPECTED | |
| NO_NULL_TERMINATION | |
| PRESERVE_ONE_BYTE_NULL | |
| REPLACE_INVALID_UTF8 | |
| bool CanMakeExternal | ( | ) |
Returns true if this string can be made external.
|
static |
Creates a new string by concatenating the left and the right strings passed in as parameters.
| bool ContainsOnlyOneByte | ( | ) | const |
Returns whether this string contain only one byte data, i.e. ISO-8859-1 code points. Will read the entire string in some cases.
A zero length string.
Definition at line 11453 of file v8.h.
References Internals::CheckInitialized(), Internals::GetRoot(), Internals::kEmptyStringRootIndex, and Local< T >::Local.
Referenced by String::NewFromUtf8Literal().
| const ExternalOneByteStringResource* GetExternalOneByteStringResource | ( | ) | const |
Get the ExternalOneByteStringResource for an external one-byte string. Returns NULL if IsExternalOneByte() doesn't return true.
| String::ExternalStringResource * GetExternalStringResource | ( | ) | const |
Get the ExternalStringResource for an external string. Returns NULL if IsExternal() doesn't return true.
Definition at line 11462 of file v8.h.
References Internals::GetInstanceType(), Internals::GetIsolateForHeapSandbox(), Internals::IsExternalTwoByteString(), Internals::kStringResourceOffset, and Internals::ReadExternalPointerField().
| String::ExternalStringResourceBase * GetExternalStringResourceBase | ( | String::Encoding * | encoding_out | ) | const |
If the string is an external string, return the ExternalStringResourceBase regardless of the encoding, otherwise return NULL. The encoding of the string is returned in encoding_out.
Definition at line 11483 of file v8.h.
References Internals::GetInstanceType(), Internals::GetIsolateForHeapSandbox(), Internals::kExternalOneByteRepresentationTag, Internals::kExternalTwoByteRepresentationTag, Internals::kFullStringRepresentationMask, Internals::kStringEncodingMask, Internals::kStringResourceOffset, and Internals::ReadExternalPointerField().
| bool IsExternal | ( | ) | const |
Returns true if the string is external
| bool IsExternalOneByte | ( | ) | const |
Returns true if the string is both external and one-byte.
| bool IsOneByte | ( | ) | const |
Returns whether this string is known to contain only one byte data, i.e. ISO-8859-1 code points. Does not read the string. False negatives are possible.
| int Length | ( | ) | const |
Returns the number of characters (UTF-16 code units) in this string.
| bool MakeExternal | ( | ExternalOneByteStringResource * | resource | ) |
Associate an external string resource with this string by transforming it in place so that existing references to this string in the JavaScript heap will use the external string resource. The external string resource's character contents need to be equivalent to this string. Returns true if the string has been changed to be an external string. The string is not modified if the operation fails. See NewExternal for information on the lifetime of the resource.
| bool MakeExternal | ( | ExternalStringResource * | resource | ) |
Associate an external string resource with this string by transforming it in place so that existing references to this string in the JavaScript heap will use the external string resource. The external string resource's character contents need to be equivalent to this string. Returns true if the string has been changed to be an external string. The string is not modified if the operation fails. See NewExternal for information on the lifetime of the resource.
|
static |
Creates a new external string using the one-byte data defined in the given resource. When the external string is no longer live on V8's heap the resource will be disposed by calling its Dispose method. The caller of this function should not otherwise delete or modify the resource. Neither should the underlying buffer be deallocated or modified except through the destructor of the external string resource.
|
static |
Creates a new external string using the data defined in the given resource. When the external string is no longer live on V8's heap the resource will be disposed by calling its Dispose method. The caller of this function should not otherwise delete or modify the resource. Neither should the underlying buffer be deallocated or modified except through the destructor of the external string resource.
|
static |
Allocates a new string from Latin-1 data. Only returns an empty value when length > kMaxLength.
|
static |
Allocates a new string from UTF-16 data. Only returns an empty value when length > kMaxLength.
|
static |
Allocates a new string from UTF-8 data. Only returns an empty value when length > kMaxLength.
Referenced by Template::Set().
|
inline |
Definition at line 3387 of file v8.h.
References String::Empty().
|
inlinestatic |
Allocates a new string from a UTF-8 literal. This is equivalent to calling String::NewFromUtf(isolate, "...").ToLocalChecked(), but without the check overhead.
When called on a string literal containing '\0', the inferred length is the length of the input array minus 1 (for the final '\0') and not the value returned by strlen.
Definition at line 3236 of file v8.h.
References String::kMaxLength.
Returns true if the strings values are equal. Same as JS ==/===.
| int Utf8Length | ( | Isolate * | isolate | ) | const |
Returns the number of bytes in the UTF-8 encoded representation of this string.
| int Write | ( | Isolate * | isolate, |
| uint16_t * | buffer, | ||
| int | start = 0, |
||
| int | length = -1, |
||
| int | options = NO_OPTIONS |
||
| ) | const |
| int WriteOneByte | ( | Isolate * | isolate, |
| uint8_t * | buffer, | ||
| int | start = 0, |
||
| int | length = -1, |
||
| int | options = NO_OPTIONS |
||
| ) | const |
| int WriteUtf8 | ( | Isolate * | isolate, |
| char * | buffer, | ||
| int | length = -1, |
||
| int * | nchars_ref = nullptr, |
||
| int | options = NO_OPTIONS |
||
| ) | const |
|
staticconstexpr |
Definition at line 3004 of file v8.h.
Referenced by String::NewFromUtf8Literal().
1.9.1 
Public Member Functions inherited from