Add gio::File, gio::FileEnumerator, gio::FileMonitor, gio::Vfs subclasses #1676

fbrouille · 2025-03-04T12:46:54Z

Allow custom implementation of gio::Vfs, gio::File, gio::FileEnumerator and gio::FileMonitor

sdroege · 2025-03-04T12:54:43Z

Very interesting, thanks! OOC, what are you planning to implement with this?

sdroege · 2025-03-04T12:56:44Z

gio/src/subclass/file_enumerator.rs

+    unsafe impl Send for MyFileEnumerator {}
+    unsafe impl Sync for MyFileEnumerator {}


These are implemented automatically if possible. Are they not, and why are they required here?

Removed. It was old code while implementing the tests.

sdroege · 2025-03-04T12:58:36Z

gio/src/subclass/file_monitor.rs

+
+    impl MyFileMonitor {
+        pub async fn tick(&self) {
+            std::thread::sleep(std::time::Duration::from_millis(10));


As this is an async function it should probably use an async sleep mechanism. glib::timeout_future() for example

sdroege · 2025-03-04T12:59:44Z

gio/src/subclass/vfs.rs

+        self.parent_is_active()
+    }
+
+    fn get_file_for_path(&self, path: &GString) -> File {


You probably also need to implement the required pieces to implement gio::File for this to be useful, or not?

Done.
Initially i through I would have to implement 70+ methods of gio::File, but finally only few ones are required for tests of gio::Vfs subclass, so it is ok.

sdroege · 2025-03-04T13:00:28Z

Just shortly looked over it, will do a proper review one of these days but generally it looks correct.

bilelmoussaoui · 2025-03-04T13:10:23Z

gio/src/subclass/vfs.rs

+        self.parent_is_active()
+    }
+
+    fn get_file_for_path(&self, path: &GString) -> File {


should it take a GString or a PathBuf?

path parameter in VfsExt::file_for_path is a &str, so I think it should be a &str.
Another alternative is to change path parameter in VfsExt::file_for_path and in gio::VfsImpl::get_file_for_path to impl AsRef<std::path::Path> as in gio::File::for_path .
What do you think ?

We should fix the annotation upstream for VfsExt::file_for_path then

fbrouille · 2025-03-05T19:12:22Z

OOC I'm planning to implement some nautilus extension in Rust (very challenging 😅)

bilelmoussaoui · 2025-03-05T20:50:35Z

gio/src/subclass/vfs.rs

+            }
+        }
+
+        unsafe impl IsImplementable<MyFile> for File {


Can you split this into subclass/file.rs even if it only implements a small subset of the vfuncs, the rest can be added later.

bilelmoussaoui · 2025-04-19T06:52:37Z

would you mind rebasing & finishing the small remaining bits here?

fbrouille · 2025-04-19T09:06:45Z

Yes, I'm adding subclass/file.rs (with almost all vfuncs), tests and a complete example to show how to implement a custom Vfs. I will share it during next week.

Signed-off-by: fbrouille <fbrouille@users.noreply.github.com>

bilelmoussaoui · 2025-04-26T20:16:37Z

gio/src/subclass/file_monitor.rs

+
+// Support parent implementation of virtual functions defined in `gio::ffi::GFileMonitorClass`.
+pub trait FileMonitorImplExt: FileMonitorImpl {
+    fn parent_cancel(&self) -> bool {


the return of this vfunc doesn't seem to be used https://gitlab.gnome.org/GNOME/glib/-/blob/main/gio/gfilemonitor.c#L254, weird but maybe we can make it return Option and fallback to TRUE if the user has no clue what to return (which is expected, i guess?)

bilelmoussaoui · 2025-04-26T20:17:23Z

gio/src/subclass/file_enumerator.rs

+        // default implementation provided by GIO
+        // klass.next_files_async = Some(next_files_async::<T>);
+        // klass.next_files_finish = Some(next_files_finish::<T>);
+        // klass.close_async = Some(close_async::<T>);
+        // klass.close_finish = Some(close_finish::<T>);


Maybe add a TODO comment so they can easily be grep-ed for ?

or at least document the why it is like this

bilelmoussaoui · 2025-04-26T20:19:08Z

gio/src/file.rs

@@ -1111,6 +1113,98 @@ pub trait FileExtManual: IsA<File> + Sized {

        (fut, Box::pin(receiver))
    }
+
+    #[doc(alias = "g_file_set_attribute")]


this could be split and we can land it already

bilelmoussaoui · 2025-04-30T14:58:32Z

gio/tests/file_monitor.rs

+                use gio::{Cancellable, File, FileMonitorFlags};
+                let _ = File::for_uri("resource:/").monitor_file(FileMonitorFlags::NONE, Cancellable::NONE);


can't you create a GType from the names and then calling T::ensure_type on it?

bilelmoussaoui · 2025-04-30T14:59:37Z

gio/tests/file_monitor.rs

+glib::wrapper! {
+    #[doc(alias = "GResourceFileMonitor")]
+    pub struct ResourceFileMonitor(Object<ffi::GResourceFileMonitor, ffi::GResourceFileMonitorClass>) @extends FileMonitor;


ResourceFileMonitor why is this here? i don't feel like it should be part of the test...

sdroege reviewed Mar 4, 2025

View reviewed changes

fbrouille force-pushed the gio_file_subclass branch from 94aacc1 to bbfa6db Compare March 4, 2025 13:03

bilelmoussaoui reviewed Mar 4, 2025

View reviewed changes

fbrouille force-pushed the gio_file_subclass branch from bbfa6db to ce47c8b Compare March 5, 2025 18:52

bilelmoussaoui reviewed Mar 5, 2025

View reviewed changes

fbrouille force-pushed the gio_file_subclass branch from ce47c8b to b4e9183 Compare April 26, 2025 09:53

fbrouille changed the title ~~Add gio::FileEnumerator, gio::FileMonitor, gio::Vfs subclasses~~ Add gio::File, gio::FileEnumerator, gio::FileMonitor, gio::Vfs subclasses Apr 26, 2025

fbrouille force-pushed the gio_file_subclass branch 5 times, most recently from c7d3812 to 7e9bab9 Compare April 26, 2025 23:01

Make parameter 'other_file' nullable in Gio.FileMonitor.emit_event

54ce596

Signed-off-by: fbrouille <fbrouille@users.noreply.github.com>

fbrouille force-pushed the gio_file_subclass branch from 7e9bab9 to e49b57d Compare April 28, 2025 17:07

fbrouille added 2 commits April 30, 2025 10:33

Add gio::FileMonitor subclass

b8b3462

Signed-off-by: fbrouille <fbrouille@users.noreply.github.com>

Add gio::FileEnumerator subclass

9b25368

Signed-off-by: fbrouille <fbrouille@users.noreply.github.com>

fbrouille force-pushed the gio_file_subclass branch 2 times, most recently from 47a3003 to e9842cc Compare April 30, 2025 11:01

fbrouille added 3 commits April 30, 2025 11:12

Add gio::File subclass

0d8025b

Signed-off-by: fbrouille <fbrouille@users.noreply.github.com>

Add gio::Vfs subclass

5fbbb09

Signed-off-by: fbrouille <fbrouille@users.noreply.github.com>

Add an example for gio::Vfs implementation

10bb6d0

Signed-off-by: fbrouille <fbrouille@users.noreply.github.com>

fbrouille force-pushed the gio_file_subclass branch from e9842cc to 10bb6d0 Compare April 30, 2025 11:12

bilelmoussaoui reviewed Apr 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add gio::File, gio::FileEnumerator, gio::FileMonitor, gio::Vfs subclasses #1676

Add gio::File, gio::FileEnumerator, gio::FileMonitor, gio::Vfs subclasses #1676

fbrouille commented Mar 4, 2025

sdroege commented Mar 4, 2025

sdroege Mar 4, 2025

fbrouille Mar 5, 2025 •

edited

Loading

sdroege Mar 4, 2025

fbrouille Mar 5, 2025 •

edited

Loading

sdroege Mar 4, 2025

fbrouille Mar 5, 2025

sdroege commented Mar 4, 2025

bilelmoussaoui Mar 4, 2025

fbrouille Mar 5, 2025

bilelmoussaoui Mar 5, 2025

fbrouille commented Mar 5, 2025

bilelmoussaoui Mar 5, 2025

bilelmoussaoui commented Apr 19, 2025

fbrouille commented Apr 19, 2025

bilelmoussaoui Apr 26, 2025

bilelmoussaoui Apr 26, 2025

bilelmoussaoui Apr 30, 2025

bilelmoussaoui Apr 26, 2025

bilelmoussaoui Apr 30, 2025

bilelmoussaoui Apr 30, 2025

		unsafe impl Send for MyFileEnumerator {}
		unsafe impl Sync for MyFileEnumerator {}

		use gio::{Cancellable, File, FileMonitorFlags};
		let _ = File::for_uri("resource:/").monitor_file(FileMonitorFlags::NONE, Cancellable::NONE);

Add gio::File, gio::FileEnumerator, gio::FileMonitor, gio::Vfs subclasses #1676

Are you sure you want to change the base?

Add gio::File, gio::FileEnumerator, gio::FileMonitor, gio::Vfs subclasses #1676

Conversation

fbrouille commented Mar 4, 2025

sdroege commented Mar 4, 2025

Choose a reason for hiding this comment

fbrouille Mar 5, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fbrouille Mar 5, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sdroege commented Mar 4, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fbrouille commented Mar 5, 2025

Choose a reason for hiding this comment

bilelmoussaoui commented Apr 19, 2025

fbrouille commented Apr 19, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fbrouille Mar 5, 2025 •

edited

Loading

fbrouille Mar 5, 2025 •

edited

Loading