Struct gdnative::api::File

pub struct File { /* fields omitted */ }

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.

Class hierarchy

File inherits methods from:

• Reference
• Object

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

impl File

Constants

pub const COMPRESSION_DEFLATE: i64

pub const COMPRESSION_FASTLZ: i64

pub const COMPRESSION_GZIP: i64

pub const COMPRESSION_ZSTD: i64

pub const READ: i64

pub const READ_WRITE: i64

pub const WRITE: i64

pub const WRITE_READ: i64

impl File

pub fn new() -> Ref<File, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn close(&self)

pub fn eof_reached(&self) -> bool

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

pub fn get_16(&self) -> i64

pub fn get_32(&self) -> i64

pub fn get_64(&self) -> i64

pub fn get_8(&self) -> i64

pub fn get_as_text(&self) -> GodotString

pub fn get_buffer(&self, len: i64) -> TypedArray<u8>

pub fn get_csv_line(
    &self,
    delim: impl Into<GodotString>
) -> TypedArray<GodotString>

pub fn get_double(&self) -> f64

pub fn endian_swap(&self) -> bool

pub fn get_error(&self) -> Result<(), GodotError>

pub fn get_float(&self) -> f64

pub fn get_len(&self) -> i64

pub fn get_line(&self) -> GodotString

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

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

pub fn get_pascal_string(&self) -> GodotString

pub fn get_path(&self) -> GodotString

pub fn get_path_absolute(&self) -> GodotString

pub fn get_position(&self) -> i64

pub fn get_real(&self) -> f64

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

pub fn get_var(&self, allow_objects: bool) -> Variant

pub fn is_open(&self) -> bool

pub fn open(
    &self,
    path: impl Into<GodotString>,
    flags: i64
) -> Result<(), GodotError>

pub fn open_compressed(
    &self,
    path: impl Into<GodotString>,
    mode_flags: i64,
    compression_mode: i64
) -> Result<(), GodotError>

pub fn open_encrypted(
    &self,
    path: impl Into<GodotString>,
    mode_flags: i64,
    key: TypedArray<u8>
) -> Result<(), GodotError>

pub fn open_encrypted_with_pass(
    &self,
    path: impl Into<GodotString>,
    mode_flags: i64,
    pass: impl Into<GodotString>
) -> Result<(), GodotError>

pub fn seek(&self, position: i64)

pub fn seek_end(&self, position: i64)

pub fn set_endian_swap(&self, enable: bool)

pub fn store_16(&self, value: i64)

pub fn store_32(&self, value: i64)

pub fn store_64(&self, value: i64)

pub fn store_8(&self, value: i64)

pub fn store_buffer(&self, buffer: TypedArray<u8>)

pub fn store_csv_line(
    &self,
    values: TypedArray<GodotString>,
    delim: impl Into<GodotString>
)

pub fn store_double(&self, value: f64)

pub fn store_float(&self, value: f64)

pub fn store_line(&self, line: impl Into<GodotString>)

pub fn store_pascal_string(&self, string: impl Into<GodotString>)

pub fn store_real(&self, value: f64)

pub fn store_string(&self, string: impl Into<GodotString>)

pub fn store_var(&self, value: impl OwnedToVariant, full_objects: bool)

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.

impl Deref for File

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for File

fn deref_mut(&mut self) -> &mut Reference

Mutably dereferences the value.

impl GodotObject for File

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

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.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for File

fn construct() -> Ref<File, Unique>

impl SubClass<Object> for File

impl SubClass<Reference> for File