Struct gdnative::api::XMLParser

pub struct XMLParser { /* fields omitted */ }

core class XMLParser 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

XMLParser 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 XMLParser

Constants

pub const NODE_CDATA: i64

pub const NODE_COMMENT: i64

pub const NODE_ELEMENT: i64

pub const NODE_ELEMENT_END: i64

pub const NODE_NONE: i64

pub const NODE_TEXT: i64

pub const NODE_UNKNOWN: i64

impl XMLParser

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

Creates a new instance of this object.

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

pub fn get_attribute_count(&self) -> i64

Gets the amount of attributes in the current element.

pub fn get_attribute_name(&self, idx: i64) -> GodotString

Gets the name of the attribute specified by the index in [code]idx[/code] argument.

pub fn get_attribute_value(&self, idx: i64) -> GodotString

Gets the value of the attribute specified by the index in [code]idx[/code] argument.

pub fn get_current_line(&self) -> i64

Gets the current line in the parsed file (currently not implemented).

pub fn get_named_attribute_value(
    &self,
    name: impl Into<GodotString>
) -> GodotString

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.

pub fn get_named_attribute_value_safe(
    &self,
    name: impl Into<GodotString>
) -> GodotString

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.

pub fn get_node_data(&self) -> GodotString

Gets the contents of a text node. This will raise an error in any other type of node.

pub fn get_node_name(&self) -> GodotString

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].

pub fn get_node_offset(&self) -> i64

Gets the byte offset of the current node since the beginning of the file or buffer.

pub fn get_node_type(&self) -> NodeType

Gets the type of the current node. Compare with [enum NodeType] constants.

pub fn has_attribute(&self, name: impl Into<GodotString>) -> bool

Check whether the current element has a certain attribute.

pub fn is_empty(&self) -> bool

Check whether the current element is empty (this only works for completely empty tags, e.g. [code]<element \>[/code]).

pub fn open(&self, file: impl Into<GodotString>) -> Result<(), GodotError>

Opens an XML file for parsing. This returns an error code.

pub fn open_buffer(&self, buffer: TypedArray<u8>) -> Result<(), GodotError>

Opens an XML raw buffer for parsing. This returns an error code.

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

Reads the next node of the file. This returns an error code.

pub fn seek(&self, position: i64) -> Result<(), GodotError>

Moves the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code.

pub fn skip_section(&self)

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>

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 XMLParser

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

Formats the value using the given formatter.

impl Deref for XMLParser

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for XMLParser

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

Mutably dereferences the value.

impl GodotObject for XMLParser

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 XMLParser

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

impl SubClass<Object> for XMLParser

impl SubClass<Reference> for XMLParser