Struct gdnative_bindings_lily::ConfigFile [−][src]
pub struct ConfigFile { /* fields omitted */ }
Expand description
core class ConfigFile
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
ConfigFile 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
.
Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist.
Deletes the specified key in a section. Raises an error if either the section or the key do not exist.
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.
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
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 default
value. If default
is not specified or set to null
, an error is also raised.
Default Arguments
default
-null
Returns true
if the specified section exists.
pub fn has_section_key(
&self,
section: impl Into<GodotString>,
key: impl Into<GodotString>
) -> bool
pub fn has_section_key(
&self,
section: impl Into<GodotString>,
key: impl Into<GodotString>
) -> bool
Returns true
if the specified section-key pair exists.
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 (OK
on success).
Loads the encrypted config file specified as a parameter, using the provided key
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 (OK
on success).
pub fn load_encrypted_pass(
&self,
path: impl Into<GodotString>,
password: impl Into<GodotString>
) -> GodotResult
pub fn load_encrypted_pass(
&self,
path: impl Into<GodotString>,
password: impl Into<GodotString>
) -> GodotResult
Loads the encrypted config file specified as a parameter, using the provided password
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 (OK
on success).
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 (OK
on success).
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 (OK
on success).
Saves the contents of the ConfigFile object to the AES-256 encrypted file specified as a parameter, using the provided key
to encrypt it. The output file uses an INI-style structure.
Returns one of the [enum Error] code constants (OK
on success).
pub fn save_encrypted_pass(
&self,
path: impl Into<GodotString>,
password: impl Into<GodotString>
) -> GodotResult
pub fn save_encrypted_pass(
&self,
path: impl Into<GodotString>,
password: impl Into<GodotString>
) -> GodotResult
Saves the contents of the ConfigFile object to the AES-256 encrypted file specified as a parameter, using the provided password
to encrypt it. The output file uses an INI-style structure.
Returns one of the [enum Error] code constants (OK
on success).
pub fn set_value(
&self,
section: impl Into<GodotString>,
key: impl Into<GodotString>,
value: impl OwnedToVariant
)
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 null
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>
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 ConfigFile
impl !Send for ConfigFile
impl !Sync for ConfigFile
impl Unpin for ConfigFile
impl UnwindSafe for ConfigFile