Struct gdnative_bindings_lily::JSONParseResult [−][src]
pub struct JSONParseResult { /* fields omitted */ }
Expand description
core class JSONParseResult
inherits Reference
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
JSONParseResult inherits methods from:
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
The error type if the JSON source was not successfully parsed. See the [enum Error] constants.
The line number where the error occurred if the JSON source was not successfully parsed.
The error message if the JSON source was not successfully parsed. See the [enum Error] constants.
Sample code is GDScript unless otherwise noted.
A Variant containing the parsed JSON. Use [method @GDScript.typeof] or the is
keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ({}
), a Dictionary will be returned. If the JSON source starts with brackets ([]
), an [Array] will be returned.
Note: The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, parsing a JSON text will convert all numerical values to [float] types.
Note: JSON objects do not preserve key order like Godot dictionaries, thus, you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements:
var p = JSON.parse('["hello", "world", "!"]')
if typeof(p.result) == TYPE_ARRAY:
print(p.result[0]) # Prints "hello"
else:
push_error("Unexpected results.")
The error type if the JSON source was not successfully parsed. See the [enum Error] constants.
The line number where the error occurred if the JSON source was not successfully parsed.
The error message if the JSON source was not successfully parsed. See the [enum Error] constants.
Sample code is GDScript unless otherwise noted.
A Variant containing the parsed JSON. Use [method @GDScript.typeof] or the is
keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ({}
), a Dictionary will be returned. If the JSON source starts with brackets ([]
), an [Array] will be returned.
Note: The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, parsing a JSON text will convert all numerical values to [float] types.
Note: JSON objects do not preserve key order like Godot dictionaries, thus, you should not rely on keys being in a certain order if a dictionary is constructed from JSON. In contrast, JSON arrays retain the order of their elements:
var p = JSON.parse('["hello", "world", "!"]')
if typeof(p.result) == TYPE_ARRAY:
print(p.result[0]) # Prints "hello"
else:
push_error("Unexpected results.")
Methods from Deref<Target = Reference>
Trait Implementations
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for JSONParseResult
impl !Send for JSONParseResult
impl !Sync for JSONParseResult
impl Unpin for JSONParseResult
impl UnwindSafe for JSONParseResult