Struct FileAccess

#[repr(C)]
pub struct FileAccess { /* private fields */ }

Expand description

Godot class FileAccess.

Inherits RefCounted.

Related symbols:

file_access: sidecar module with related enum/flag types
IFileAccess: virtual methods

§Specific notes for this class

The gdext library provides a higher-level abstraction, which should be preferred: GFile.

§Not instantiable

This class cannot be constructed. Obtain Gd<FileAccess> instances via Godot APIs.

Implementations§

§

impl FileAccess

pub fn open(path: GString, flags: ModeFlags) -> Option<Gd<FileAccess>>

pub fn open_encrypted( path: GString, mode_flags: ModeFlags, key: &PackedByteArray, ) -> Option<Gd<FileAccess>>

pub fn open_encrypted_with_pass( path: GString, mode_flags: ModeFlags, pass: GString, ) -> Option<Gd<FileAccess>>

pub fn open_compressed( path: GString, mode_flags: ModeFlags, ) -> Option<Gd<FileAccess>>

To set the default parameters, use Self::open_compressed_ex and its builder methods. See the book for detailed usage instructions.

pub fn open_compressed_ex( path: GString, mode_flags: ModeFlags, ) -> ExOpenCompressed

pub fn get_open_error() -> Error

pub fn get_file_as_bytes(path: GString) -> PackedByteArray

pub fn get_file_as_string(path: GString) -> GString

pub fn resize(&mut self, length: i64) -> Error

pub fn flush(&mut self)

pub fn get_path(&self) -> GString

pub fn get_path_absolute(&self) -> GString

pub fn is_open(&self) -> bool

pub fn seek(&mut self, position: u64)

pub fn seek_end(&mut self)

To set the default parameters, use Self::seek_end_ex and its builder methods. See the book for detailed usage instructions.

pub fn seek_end_ex<'a>(&'a mut self) -> ExSeekEnd<'a>

pub fn get_position(&self) -> u64

pub fn get_length(&self) -> u64

pub fn eof_reached(&self) -> bool

pub fn get_8(&self) -> u8

pub fn get_16(&self) -> u16

pub fn get_32(&self) -> u32

pub fn get_64(&self) -> u64

pub fn get_float(&self) -> f32

pub fn get_double(&self) -> f64

pub fn get_real(&self) -> f32

pub fn get_buffer(&self, length: i64) -> PackedByteArray

pub fn get_line(&self) -> GString

pub fn get_csv_line(&self) -> PackedStringArray

To set the default parameters, use Self::get_csv_line_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_csv_line_ex<'a>(&'a self) -> ExGetCsvLine<'a>

pub fn get_as_text(&self) -> GString

To set the default parameters, use Self::get_as_text_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_as_text_ex<'a>(&'a self) -> ExGetAsText<'a>

pub fn get_md5(path: GString) -> GString

pub fn get_sha256(path: GString) -> GString

pub fn is_big_endian(&self) -> bool

pub fn set_big_endian(&mut self, big_endian: bool)

pub fn get_error(&self) -> Error

pub fn get_var(&self) -> Variant

To set the default parameters, use Self::get_var_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_var_ex<'a>(&'a self) -> ExGetVar<'a>

pub fn store_8(&mut self, value: u8)

pub fn store_16(&mut self, value: u16)

pub fn store_32(&mut self, value: u32)

pub fn store_64(&mut self, value: u64)

pub fn store_float(&mut self, value: f32)

pub fn store_double(&mut self, value: f64)

pub fn store_real(&mut self, value: f32)

pub fn store_buffer(&mut self, buffer: &PackedByteArray)

pub fn store_line(&mut self, line: GString)

pub fn store_csv_line<'a>(&mut self, values: &'a PackedStringArray)

To set the default parameters, use Self::store_csv_line_ex and its builder methods. See the book for detailed usage instructions.

pub fn store_csv_line_ex<'a>( &'a mut self, values: &'a PackedStringArray, ) -> ExStoreCsvLine<'a>

pub fn store_string(&mut self, string: GString)

pub fn store_var<'a>(&mut self, value: &'a Variant)

To set the default parameters, use Self::store_var_ex and its builder methods. See the book for detailed usage instructions.

pub fn store_var_ex<'a>(&'a mut self, value: &'a Variant) -> ExStoreVar<'a>

pub fn store_pascal_string(&mut self, string: GString)

pub fn get_pascal_string(&mut self) -> GString

pub fn close(&mut self)

pub fn file_exists(path: GString) -> bool

pub fn get_modified_time(file: GString) -> u64

pub fn get_unix_permissions(file: GString) -> UnixPermissionFlags

pub fn set_unix_permissions( file: GString, permissions: UnixPermissionFlags, ) -> Error

pub fn get_hidden_attribute(file: GString) -> bool

pub fn set_hidden_attribute(file: GString, hidden: bool) -> Error

pub fn set_read_only_attribute(file: GString, ro: bool) -> Error

pub fn get_read_only_attribute(file: GString) -> bool

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>§

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: GString) -> bool

pub fn set(&mut self, property: StringName, value: &Variant)

pub fn get(&self, property: StringName) -> Variant

pub fn set_indexed(&mut self, property_path: NodePath, value: &Variant)

pub fn get_indexed(&self, property_path: NodePath) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: StringName) -> bool

pub fn property_get_revert(&self, property: StringName) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: &Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: StringName) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>(&'a self, name: StringName) -> ExGetMeta<'a>

pub fn has_meta(&self, name: StringName) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: GString)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: GString, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: StringName) -> bool

pub fn remove_user_signal(&mut self, signal: StringName)

pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred(&mut self, property: StringName, value: &Variant)

pub fn callv( &mut self, method: StringName, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: StringName) -> bool

pub fn get_method_argument_count(&self, method: StringName) -> i32

pub fn has_signal(&self, signal: StringName) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: StringName, callable: Callable, ) -> ExConnect<'a>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: StringName) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: StringName) -> ExTr<'a>

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

§Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.