Struct DirAccess

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

Godot class DirAccess.

Inherits RefCounted.

Related symbols:

• dir_access: sidecar module with related enum/flag types
• IDirAccess: virtual methods

See also Godot docs for DirAccess.

Not instantiable

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

Implementations

impl DirAccess

pub fn open(path: impl AsArg<GString>) -> Option<Gd<DirAccess>>

pub fn get_open_error() -> Error

pub fn list_dir_begin(&mut self) -> Error

pub fn get_next(&mut self) -> GString

pub fn current_is_dir(&self) -> bool

pub fn list_dir_end(&mut self)

pub fn get_files(&mut self) -> PackedStringArray

pub fn get_files_at(path: impl AsArg<GString>) -> PackedStringArray

pub fn get_directories(&mut self) -> PackedStringArray

pub fn get_directories_at(path: impl AsArg<GString>) -> PackedStringArray

pub fn get_drive_count() -> i32

pub fn get_drive_name(idx: i32) -> GString

pub fn get_current_drive(&mut self) -> i32

pub fn change_dir(&mut self, to_dir: impl AsArg<GString>) -> Error

pub fn get_current_dir(&self) -> GString

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

pub fn get_current_dir_ex<'a>(&'a self) -> ExGetCurrentDir<'a>

pub fn make_dir(&mut self, path: impl AsArg<GString>) -> Error

pub fn make_dir_absolute(path: impl AsArg<GString>) -> Error

pub fn make_dir_recursive(&mut self, path: impl AsArg<GString>) -> Error

pub fn make_dir_recursive_absolute(path: impl AsArg<GString>) -> Error

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

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

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

pub fn get_space_left(&mut self) -> u64

pub fn copy( &mut self, from: impl AsArg<GString>, to: impl AsArg<GString>, ) -> Error

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

pub fn copy_ex<'a>( &'a mut self, from: impl AsArg<GString> + 'a, to: impl AsArg<GString> + 'a, ) -> ExCopy<'a>

pub fn copy_absolute( from: impl AsArg<GString>, to: impl AsArg<GString>, ) -> Error

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

pub fn copy_absolute_ex<'a>( from: impl AsArg<GString> + 'a, to: impl AsArg<GString> + 'a, ) -> ExCopyAbsolute<'a>

pub fn rename( &mut self, from: impl AsArg<GString>, to: impl AsArg<GString>, ) -> Error

pub fn rename_absolute( from: impl AsArg<GString>, to: impl AsArg<GString>, ) -> Error

pub fn remove(&mut self, path: impl AsArg<GString>) -> Error

pub fn remove_absolute(path: impl AsArg<GString>) -> Error

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

pub fn read_link(&mut self, path: impl AsArg<GString>) -> GString

pub fn create_link( &mut self, source: impl AsArg<GString>, target: impl AsArg<GString>, ) -> Error

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

pub fn get_include_navigational(&self) -> bool

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

pub fn get_include_hidden(&self) -> bool

pub fn is_case_sensitive(&self, path: 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: &Array<Variant>, ) -> 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 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 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 DirAccess

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 DirAccess

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

Formats the value using the given formatter.

impl Deref for DirAccess

type Target = RefCounted

The resulting type after dereferencing.

fn deref(&self) -> &<DirAccess as Deref>::Target

Dereferences the value.

impl DerefMut for DirAccess

fn deref_mut(&mut self) -> &mut <DirAccess as Deref>::Target

Mutably dereferences the value.

impl GodotClass for DirAccess

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>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl Inherits<Object> for DirAccess

impl Inherits<RefCounted> for DirAccess