Struct gdnative::api::ConfigFile

pub struct ConfigFile { /* fields omitted */ }

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

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

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

Creates a new instance of this object.

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

pub fn erase_section(&self, section: impl Into<GodotString>)

Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist.

pub fn erase_section_key(
    &self,
    section: impl Into<GodotString>,
    key: impl Into<GodotString>
)

Deletes the specified key in a section. Raises an error if either the section or the key do not exist.

pub fn get_section_keys(
    &self,
    section: impl Into<GodotString>
) -> TypedArray<GodotString>

Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist.

pub fn get_sections(&self) -> TypedArray<GodotString>

Returns an array of all defined section identifiers.

pub fn get_value(
    &self,
    section: impl Into<GodotString>,
    key: impl Into<GodotString>,
    default: impl OwnedToVariant
) -> Variant

Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback [code]default[/code] value. If [code]default[/code] is not specified or set to [code]null[/code], an error is also raised.

Default Arguments

• default - null

pub fn has_section(&self, section: impl Into<GodotString>) -> bool

Returns [code]true[/code] if the specified section exists.

pub fn has_section_key(
    &self,
    section: impl Into<GodotString>,
    key: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if the specified section-key pair exists.

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

Loads the config file specified as a parameter. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
				Returns one of the [enum Error] code constants ([code]OK[/code] on success).

pub fn load_encrypted(
    &self,
    path: impl Into<GodotString>,
    key: TypedArray<u8>
) -> Result<(), GodotError>

Loads the encrypted config file specified as a parameter, using the provided [code]key[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
				Returns one of the [enum Error] code constants ([code]OK[/code] on success).

pub fn load_encrypted_pass(
    &self,
    path: impl Into<GodotString>,
    password: impl Into<GodotString>
) -> Result<(), GodotError>

Loads the encrypted config file specified as a parameter, using the provided [code]password[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
				Returns one of the [enum Error] code constants ([code]OK[/code] on success).

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

Parses the the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on.
				Returns one of the [enum Error] code constants ([code]OK[/code] on success).

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

Saves the contents of the [ConfigFile] object to the file specified as a parameter. The output file uses an INI-style structure.
				Returns one of the [enum Error] code constants ([code]OK[/code] on success).

pub fn save_encrypted(
    &self,
    path: impl Into<GodotString>,
    key: TypedArray<u8>
) -> Result<(), GodotError>

Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]key[/code] to encrypt it. The output file uses an INI-style structure.
				Returns one of the [enum Error] code constants ([code]OK[/code] on success).

pub fn save_encrypted_pass(
    &self,
    path: impl Into<GodotString>,
    password: impl Into<GodotString>
) -> Result<(), GodotError>

Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]password[/code] to encrypt it. The output file uses an INI-style structure.
				Returns one of the [enum Error] code constants ([code]OK[/code] on success).

pub fn set_value(
    &self,
    section: impl Into<GodotString>,
    key: impl Into<GodotString>,
    value: impl OwnedToVariant
)

Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a [code]null[/code] value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.

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 ConfigFile

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

Formats the value using the given formatter.

impl Deref for ConfigFile

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for ConfigFile

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

Mutably dereferences the value.

impl GodotObject for ConfigFile

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 ConfigFile

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

impl SubClass<Object> for ConfigFile

impl SubClass<Reference> for ConfigFile