Struct FileAccess

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

Godot class FileAccess.

Inherits RefCounted.

Related symbols:

• file_access: sidecar module with related enum/flag types

See also Godot docs for FileAccess.

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.

Final class

This class is final, meaning you cannot inherit from it, and it comes without I* interface trait. It is still possible that other Godot classes inherit from it, but that is limited to the engine itself.

Implementations

impl FileAccess

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

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

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

pub fn open_encrypted_ex<'a>( path: impl AsArg<GString> + 'a, mode_flags: ModeFlags, key: &'a PackedByteArray, ) -> ExOpenEncrypted<'a>

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

pub fn open_compressed( path: impl AsArg<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<'a>( path: impl AsArg<GString> + 'a, mode_flags: ModeFlags, ) -> ExOpenCompressed<'a>

pub fn get_open_error() -> Error

pub fn create_temp(mode_flags: i32) -> Option<Gd<FileAccess>>

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

pub fn create_temp_ex<'a>(mode_flags: i32) -> ExCreateTemp<'a>

pub fn get_file_as_bytes(path: impl AsArg<GString>) -> PackedByteArray

pub fn get_file_as_string(path: impl AsArg<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_half(&self) -> f32

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: impl AsArg<GString>) -> GString

pub fn get_sha256(path: impl AsArg<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) -> bool

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

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

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

pub fn store_half(&mut self, value: f32) -> bool

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

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

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

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

pub fn store_line(&mut self, line: impl AsArg<GString>) -> bool

pub fn store_csv_line(&mut self, values: &PackedStringArray) -> bool

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: impl AsArg<GString>) -> bool

pub fn store_var(&mut self, value: &Variant) -> bool

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: impl AsArg<GString>) -> bool

pub fn get_pascal_string(&mut self) -> GString

pub fn close(&mut self)

pub fn file_exists(path: impl AsArg<GString>) -> bool

pub fn get_modified_time(file: impl AsArg<GString>) -> u64

pub fn get_unix_permissions(file: impl AsArg<GString>) -> UnixPermissionFlags

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

pub fn get_hidden_attribute(file: impl AsArg<GString>) -> bool

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

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

pub fn get_read_only_attribute(file: impl AsArg<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: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

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

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<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: impl AsArg<StringName>) -> bool

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

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

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<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: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

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

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

pub fn add_user_signal(&mut self, signal: impl AsArg<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: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

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

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<StringName>, value: &Variant, )

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

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

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

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

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

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

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

pub fn connect( &mut self, signal: impl AsArg<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: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

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

pub fn has_connections(&self, signal: impl AsArg<StringName>) -> 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: impl AsArg<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: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<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: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn get_translation_domain(&self) -> StringName

pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)

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.

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

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for FileAccess

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for FileAccess

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

Formats the value using the given formatter.

impl Deref for FileAccess

type Target = RefCounted

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for FileAccess

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl GodotClass for FileAccess

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = RefCounted

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

fn inherits<U: GodotClass>() -> bool

Returns whether Self inherits from U.

impl WithSignals for FileAccess

Available on since_api="4.2" only.

type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>

The associated struct listing all signals of this class.

impl Inherits<Object> for FileAccess

impl Inherits<RefCounted> for FileAccess