rfd 0.0.3

Rusty File Dialog
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

use std::path::Path;
use std::path::PathBuf;

pub enum DialogType {
    PickFile,
    PickFiles,
    PickFolder,
    SaveFile,
}
impl Default for DialogType {
    fn default() -> Self {
        Self::PickFile
    }
}

pub struct Filter<'a> {
    pub name: &'a str,
    pub extensions: &'a [&'a str],
}

#[derive(Default)]
pub struct Dialog<'a> {
    dialog_type: DialogType,
    filters: Vec<Filter<'a>>,
    starting_directory: Option<&'a Path>,
}

impl<'a> Dialog<'a> {
    pub fn new(dialog_type: DialogType) -> Self {
        Self {
            dialog_type,
            ..Default::default()
        }
    }

    pub fn pick_file() -> Self {
        Self::new(DialogType::PickFile)
    }

    pub fn pick_files() -> Self {
        Self::new(DialogType::PickFiles)
    }

    pub fn pick_folder() -> Self {
        Self::new(DialogType::PickFolder)
    }

    pub fn save_file() -> Self {
        Self::new(DialogType::SaveFile)
    }

    pub fn add_filter(mut self, name: &'a str, extensions: &'a [&'a str]) -> Self {
        self.filters.push(Filter { name, extensions });
        self
    }

    pub fn starting_directory<P: AsRef<Path>>(mut self, path: &'a P) -> Self {
        self.starting_directory = Some(path.as_ref());
        self
    }

    pub fn open(self) -> Vec<PathBuf> {
        let opt = DialogOptions {
            filters: &self.filters,
            starting_directory: self.starting_directory,
        };
        match self.dialog_type {
            DialogType::PickFile => crate::pick_file(opt).map(|f| vec![f]).unwrap_or(vec![]),
            DialogType::PickFiles => crate::pick_files(opt).unwrap_or(vec![]),
            DialogType::PickFolder => crate::pick_folder(opt).map(|f| vec![f]).unwrap_or(vec![]),
            DialogType::SaveFile => crate::save_file(opt).map(|f| vec![f]).unwrap_or(vec![]),
        }
    }
}

/// Paramaters to pass to the file dialog.
#[derive(Default)]
pub struct DialogOptions<'a> {
    pub filters: &'a [Filter<'a>],
    pub starting_directory: Option<&'a Path>,
}

impl<'a> DialogOptions<'a> {
    /// Creates a new `DialogParams` with nothing configured.
    pub fn new() -> Self {
        Self {
            filters: &[],
            starting_directory: None,
        }
    }

    /// Sets the filters of this `DialogParams`.
    pub fn set_filters(mut self, filters: &'a [Filter<'a>]) -> Self {
        self.filters = filters;
        self
    }

    pub fn set_starting_directory<T: AsRef<Path>>(mut self, path: &'a T) -> Self {
        self.starting_directory = Some(path.as_ref());
        self
    }
}