Struct gdnative_bindings_lily::XMLParser [−][src]
pub struct XMLParser { /* fields omitted */ }
Expand description
core class XMLParser
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
XMLParser 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
Constants
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Gets the amount of attributes in the current element.
Gets the name of the attribute specified by the index in idx
argument.
Gets the value of the attribute specified by the index in idx
argument.
Gets the current line in the parsed file (currently not implemented).
Gets the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute.
Gets the value of a certain attribute of the current element by name. This will return an empty String if the attribute is not found.
Gets the contents of a text node. This will raise an error in any other type of node.
Gets the name of the current element node. This will raise an error if the current node type is neither [constant NODE_ELEMENT] nor [constant NODE_ELEMENT_END].
Gets the byte offset of the current node since the beginning of the file or buffer.
Gets the type of the current node. Compare with [enum NodeType] constants.
Check whether the current element has a certain attribute.
Check whether the current element is empty (this only works for completely empty tags, e.g. <element \>
).
Opens an XML file for parsing. This returns an error code.
Opens an XML raw buffer for parsing. This returns an error code.
Reads the next node of the file. This returns an error code.
Moves the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code.
Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element.
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 XMLParser
impl UnwindSafe for XMLParser