Struct File

pub struct File { /* private fields */ }

core class File 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.

Feature flag

This type is behind the gdnative crate’s common feature flag.

Class hierarchy

File inherits methods from:

• Reference
• Object

Implementations

impl File

pub fn new() -> Self

pub fn new_ref(&self) -> Self

Creates a new reference to the same reference-counted object.

pub fn open_encrypted( &mut self, path: GodotString, mode_flags: i64, key: ByteArray, ) -> GodotResult

pub fn open_encrypted_with_pass( &mut self, path: GodotString, mode_flags: i64, pass: GodotString, ) -> GodotResult

pub fn open_compressed( &mut self, path: GodotString, mode_flags: i64, compression_mode: i64, ) -> GodotResult

pub fn open(&mut self, path: GodotString, flags: i64) -> GodotResult

pub fn close(&mut self)

pub fn get_path(&self) -> GodotString

pub fn get_path_absolute(&self) -> GodotString

pub fn is_open(&self) -> bool

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

pub fn seek_end(&mut self, position: i64)

pub fn get_position(&self) -> i64

pub fn get_len(&self) -> i64

pub fn eof_reached(&self) -> bool

pub fn get_8(&self) -> i64

pub fn get_16(&self) -> i64

pub fn get_32(&self) -> i64

pub fn get_64(&self) -> i64

pub fn get_float(&self) -> f64

pub fn get_double(&self) -> f64

pub fn get_real(&self) -> f64

pub fn get_buffer(&self, len: i64) -> ByteArray

pub fn get_line(&self) -> GodotString

pub fn get_as_text(&self) -> GodotString

pub fn get_md5(&self, path: GodotString) -> GodotString

pub fn get_sha256(&self, path: GodotString) -> GodotString

pub fn get_endian_swap(&mut self) -> bool

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

pub fn get_error(&self) -> GodotResult

pub fn get_var(&self) -> Variant

pub fn get_csv_line(&self, delim: GodotString) -> StringArray

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

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

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

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

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

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

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

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

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

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

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

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

pub fn get_pascal_string(&mut self) -> GodotString

pub fn file_exists(&self, path: GodotString) -> bool

pub fn get_modified_time(&self, file: GodotString) -> i64

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

pub fn _notification(&mut self, what: i64)

Inherited from Object.

pub fn _set(&mut self, property: GodotString, value: Variant) -> bool

Inherited from Object.

pub fn _get(&mut self, property: GodotString) -> Variant

Inherited from Object.

pub fn _get_property_list(&mut self) -> VariantArray

Inherited from Object.

pub fn _init(&mut self)

Inherited from Object.

pub fn get_class(&self) -> GodotString

Inherited from Object.

pub fn is_class(&self, _type: GodotString) -> bool

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub fn get_property_list(&self) -> VariantArray

Inherited from Object.

pub fn get_method_list(&self) -> VariantArray

Inherited from Object.

pub fn notification(&mut self, what: i64, reversed: bool)

Inherited from Object.

pub fn get_instance_id(&self) -> i64

Inherited from Object.

pub fn set_script(&mut self, script: Option<Reference>)

Inherited from Object.

pub fn get_script(&self) -> Option<Reference>

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub fn get_meta_list(&self) -> StringArray

Inherited from Object.

pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

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

Inherited from Object.

pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant

Inherited from Object.

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

Inherited from Object.

pub fn get_signal_list(&self) -> VariantArray

Inherited from Object.

pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray

Inherited from Object.

pub fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

pub fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult

Inherited from Object.

pub fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )

Inherited from Object.

pub fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool

Inherited from Object.

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

Inherited from Object.

pub fn is_blocking_signals(&self) -> bool

Inherited from Object.

pub fn property_list_changed_notify(&mut self)

Inherited from Object.

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

Inherited from Object.

pub fn can_translate_messages(&self) -> bool

Inherited from Object.

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

Inherited from Object.

pub fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.

impl Drop for File

fn drop(&mut self)

Executes the destructor for this type.

impl GodotObject for File

fn class_name() -> &'static str

impl ToVariant for File

fn to_variant(&self) -> Variant

fn from_variant(variant: &Variant) -> Option<Self>