nfd2

Crates.ionfd2
lib.rsnfd2
version0.3.1
sourcesrc
created_at2020-03-19 08:44:55.191685
updated_at2022-02-04 13:09:11.034448
descriptionPlease use https://crates.io/crates/rfd instead
homepagehttps://github.com/EmbarkStudios/nfd2
repositoryhttps://github.com/EmbarkStudios/nfd2
max_upload_size
id220383
size176,169
(embark-studios)

documentation

https://docs.rs/nfd2

README

💾 nfd2

Build Status Crates.io Docs Contributor Covenant Embark

nfd2 is a Rust binding to the nativefiledialog library, that provides a convenient cross-platform interface to opening file dialogs on Windows, MacOS, and Linux.

This is a fork!

The original nfd-rs crate appears essentially unmaintained by now, so we have made this fork with the intent of making sure that it is at least maintained and that bugs stay fixed so we can have something to rely on.

That being said, our ultimate goal with this crate is to eventually make it pure Rust, without a need for external C code or a build script at all.

Dependencies

Since this crate currently depends on nativefiledialog, you must have the dependencies for that project installed. See Compiling Your Programs in the README.md file for nativefiledialog for more information on the requirements for each platform.

Linux

Linux requires the GTK3 development package(s) to be installed before building:

  • Debian/Ubuntu: apt-get install libgtk-3-dev
  • Fedora: dnf install gtk3-devel

Other

Other platforms do not require additional installation.

Usage

Single File Dialog

use nfd2::Response;

fn main() {
    match nfd2::open_file_dialog(None, None).expect("oh no") {
        Response::Okay(file_path) => println!("File path = {:?}", file_path),
        Response::OkayMultiple(files) => println!("Files {:?}", files),
        Response::Cancel => println!("User canceled"),
    }
}

Multiple File Dialog

use nfd2::Response;

fn main() {
    /// Only show .jpg files
    let result = nfd2::dialog_multiple().filter("jpg").open().expect("oh no");

    match result {
        Response::Okay(file_path) => println!("File path = {:?}", file_path),
        Response::OkayMultiple(files) => println!("Files {:?}", files),
        Response::Cancel => println!("User canceled"),
    }
}

Contributing

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started.

License

MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT) AND Zlib (Zlib or https://opensource.org/licenses/Zlib)

Commit count: 29

cargo fmt