Struct gdnative_bindings_lily::File [−][src]
pub struct File { /* fields omitted */ }Expand description
core class File 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
File 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.
Returns true if the file cursor has read past the end of the file.
Note: This function will still return false while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low-level file access works in all operating systems. There is always [method get_len] and [method get_position] to implement a custom logic.
Returns true if the file exists in the given path.
Note: Many resources types are imported (e.g. textures or sound files), and that their source asset will not be included in the exported game, as only the imported version is used (in the res://.import folder). To check for the existence of such resources while taking into account the remapping to their imported location, use [method ResourceLoader.exists]. Typically, using File.file_exists on an imported resource would work while you are developing in the editor (the source asset is present in res://, but fail when exported).
Returns the next 16 bits from the file as an integer. See [method store_16] for details on what values can be stored and retrieved this way.
Returns the next 32 bits from the file as an integer. See [method store_32] for details on what values can be stored and retrieved this way.
Returns the next 64 bits from the file as an integer. See [method store_64] for details on what values can be stored and retrieved this way.
Returns the next 8 bits from the file as an integer. See [method store_8] for details on what values can be stored and retrieved this way.
Returns the whole file as a String. Text is interpreted as being UTF-8 encoded.
Returns next len bytes of the file as a [PoolByteArray].
Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter delim to use other than the default "," (comma). This delimiter must be one-character long.
Text is interpreted as being UTF-8 encoded.
Default Arguments
delim-","
Returns the next 64 bits from the file as a floating-point number.
If true, the file’s endianness is swapped. Use this if you’re dealing with files written on big-endian machines.
Note: This is about the file format, not CPU type. This is always reset to false whenever you open the file.
Returns the last error that happened when trying to perform operations. Compare with the ERR_FILE_* constants from [enum Error].
Returns the next 32 bits from the file as a floating-point number.
Returns the next line of the file as a String. Text is interpreted as being UTF-8 encoded.
Returns an MD5 String representing the file at the given path or an empty String on failure.
Returns the last time the file was modified in unix timestamp format or returns a String “ERROR IN file”. This unix timestamp can be converted to datetime by using [method OS.get_datetime_from_unix_time].
Returns a String saved in Pascal format from the file. Text is interpreted as being UTF-8 encoded.
Returns the path as a String for the current open file.
Returns the absolute path as a String for the current open file.
Returns the file cursor’s position.
Returns the next Variant value from the file. If allow_objects is true, decoding objects is allowed.
Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
Default Arguments
allow_objects-false
Opens the file for writing or reading, depending on the flags.
pub fn open_compressed(
&self,
path: impl Into<GodotString>,
mode_flags: i64,
compression_mode: i64
) -> GodotResult
pub fn open_compressed(
&self,
path: impl Into<GodotString>,
mode_flags: i64,
compression_mode: i64
) -> GodotResultpub fn open_encrypted(
&self,
path: impl Into<GodotString>,
mode_flags: i64,
key: ByteArray
) -> GodotResult
pub fn open_encrypted(
&self,
path: impl Into<GodotString>,
mode_flags: i64,
key: ByteArray
) -> GodotResultOpens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. Note: The provided key must be 32 bytes long.
pub fn open_encrypted_with_pass(
&self,
path: impl Into<GodotString>,
mode_flags: i64,
pass: impl Into<GodotString>
) -> GodotResult
pub fn open_encrypted_with_pass(
&self,
path: impl Into<GodotString>,
mode_flags: i64,
pass: impl Into<GodotString>
) -> GodotResultOpens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file).
Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note: This is an offset, so you should use negative numbers or the cursor will be at the end of the file.
Default Arguments
position-0
If true, the file’s endianness is swapped. Use this if you’re dealing with files written on big-endian machines.
Note: This is about the file format, not CPU type. This is always reset to false whenever you open the file.
Sample code is GDScript unless otherwise noted.
Stores an integer as 16 bits in the file.
Note: The value should lie in the interval [0, 2^16 - 1]. Any other value will overflow and wrap around.
To store a signed integer, use [method store_64] or store a signed integer from the interval [-2^15, 2^15 - 1] (i.e. keeping one bit for the signedness) and compute its sign manually when reading. For example:
const MAX_15B = 1 << 15
const MAX_16B = 1 << 16
func unsigned16_to_signed(unsigned):
return (unsigned + MAX_15B) % MAX_16B - MAX_15B
func _ready():
var f = File.new()
f.open("user://file.dat", File.WRITE_READ)
f.store_16(-42) # This wraps around and stores 65494 (2^16 - 42).
f.store_16(121) # In bounds, will store 121.
f.seek(0) # Go back to start to read the stored value.
var read1 = f.get_16() # 65494
var read2 = f.get_16() # 121
var converted1 = unsigned16_to_signed(read1) # -42
var converted2 = unsigned16_to_signed(read2) # 121
Stores an integer as 32 bits in the file.
Note: The value should lie in the interval [0, 2^32 - 1]. Any other value will overflow and wrap around.
To store a signed integer, use [method store_64], or convert it manually (see [method store_16] for an example).
Stores an integer as 64 bits in the file.
Note: The value must lie in the interval [-2^63, 2^63 - 1] (i.e. be a valid [int] value).
Stores an integer as 8 bits in the file.
Note: The value should lie in the interval [0, 255]. Any other value will overflow and wrap around.
To store a signed integer, use [method store_64], or convert it manually (see [method store_16] for an example).
Stores the given array of bytes in the file.
Store the given [PoolStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter delim to use other than the default "," (comma). This delimiter must be one-character long.
Text will be encoded as UTF-8.
Default Arguments
delim-","
Stores a floating-point number as 64 bits in the file.
Stores a floating-point number as 32 bits in the file.
Stores the given String as a line in the file. Text will be encoded as UTF-8.
Stores the given String as a line in the file in Pascal format (i.e. also store the length of the string). Text will be encoded as UTF-8.
Stores a floating-point number in the file.
Stores the given String in the file. Text will be encoded as UTF-8.
Stores any Variant value in the file. If full_objects is true, encoding objects is allowed (and can potentially include code).
Default Arguments
full_objects-false
Methods from Deref<Target = Reference>
Trait Implementations
type RefKind = RefCounted
type RefKind = RefCountedCreates 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 Fileimpl UnwindSafe for File