Struct gdnative::api::JSONParseResult

pub struct JSONParseResult { /* fields omitted */ }

core class JSONParseResult inherits Reference (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

JSONParseResult inherits methods from:

• Reference
• Object

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

impl JSONParseResult

pub fn new() -> Ref<JSONParseResult, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn error(&self) -> Result<(), GodotError>

The error type if the JSON source was not successfully parsed. See the [enum Error] constants.

pub fn error_line(&self) -> i64

The line number where the error occurred if the JSON source was not successfully parsed.

pub fn error_string(&self) -> GodotString

The error message if the JSON source was not successfully parsed. See the [enum Error] constants.

pub fn result(&self) -> Variant

A [Variant] containing the parsed JSON. Use [method @GDScript.typeof] or the [code]is[/code] keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ([code]{}[/code]), a [Dictionary] will be returned. If the JSON source starts with brackets ([code][][/code]), an [Array] will be returned.
			[b]Note:[/b] 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.
			[b]Note:[/b] 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:
			[codeblock]
			var p = JSON.parse('["hello", "world", "!"]')
			if typeof(p.result) == TYPE_ARRAY:
			    print(p.result[0]) # Prints "hello"
			else:
			    push_error("Unexpected results.")
			[/codeblock]

pub fn set_error(&self, error: i64)

The error type if the JSON source was not successfully parsed. See the [enum Error] constants.

pub fn set_error_line(&self, error_line: i64)

The line number where the error occurred if the JSON source was not successfully parsed.

pub fn set_error_string(&self, error_string: impl Into<GodotString>)

The error message if the JSON source was not successfully parsed. See the [enum Error] constants.

pub fn set_result(&self, result: impl OwnedToVariant)

A [Variant] containing the parsed JSON. Use [method @GDScript.typeof] or the [code]is[/code] keyword to check if it is what you expect. For example, if the JSON source starts with curly braces ([code]{}[/code]), a [Dictionary] will be returned. If the JSON source starts with brackets ([code][][/code]), an [Array] will be returned.
			[b]Note:[/b] 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.
			[b]Note:[/b] 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:
			[codeblock]
			var p = JSON.parse('["hello", "world", "!"]')
			if typeof(p.result) == TYPE_ARRAY:
			    print(p.result[0]) # Prints "hello"
			else:
			    push_error("Unexpected results.")
			[/codeblock]

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for JSONParseResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for JSONParseResult

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for JSONParseResult

fn deref_mut(&mut self) -> &mut Reference

Mutably dereferences the value.

impl GodotObject for JSONParseResult

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

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.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for JSONParseResult

fn construct() -> Ref<JSONParseResult, Unique>

impl SubClass<Object> for JSONParseResult

impl SubClass<Reference> for JSONParseResult