Struct FileSelection 

pub struct FileSelection { /* private fields */ }

A file chooser dialog box.

This dialog box opens a file choser with an optional title in the specified path. If the path is not specified, it defaults to the user’s home directory.

The backends might support multiple operation modes, for example open or save dialogs. You can select a mode using the FileSelectionMode enum, though the backend might ignore the mode and just display a simple file dialog. Per default, the mode is set to Open.

Example

use dialog::DialogBox;

let choice = dialog::FileSelection::new("Please select a file")
    .title("File Selection")
    .path("/home/user/Downloads")
    .show()
    .expect("Could not display dialog box");
println!("The user chose: {:?}", choice);

Implementations

impl FileSelection

pub fn new(text: impl Into<String>) -> FileSelection

Creates a new file chooser with the given path.

Examples found in repository

examples/file_selection.rs (line 7)

fn main() -> dialog::Result<()> {
    let choice = dialog::FileSelection::new("Please select a file")
        .title("File Chooser Example (Open)")
        .path("/etc")
        .show()?;
    println!("The user chose: {:?}", choice);

    let choice = dialog::FileSelection::new("Please select a file")
        .title("File Chooser Example (Save)")
        .mode(dialog::FileSelectionMode::Save)
        .path("/etc")
        .show()?;
    println!("The user chose: {:?}", choice);

    Ok(())
}

pub fn title(&mut self, title: impl Into<String>) -> &mut FileSelection

Sets the title of this file chooser dialog box.

This method returns a reference to self to enable chaining.

Examples found in repository

examples/file_selection.rs (line 8)

fn main() -> dialog::Result<()> {
    let choice = dialog::FileSelection::new("Please select a file")
        .title("File Chooser Example (Open)")
        .path("/etc")
        .show()?;
    println!("The user chose: {:?}", choice);

    let choice = dialog::FileSelection::new("Please select a file")
        .title("File Chooser Example (Save)")
        .mode(dialog::FileSelectionMode::Save)
        .path("/etc")
        .show()?;
    println!("The user chose: {:?}", choice);

    Ok(())
}

pub fn path(&mut self, path: impl AsRef<Path>) -> &mut FileSelection

Sets the path of this file chooser dialog box.

This method returns a reference to self to enable chaining.

Examples found in repository

examples/file_selection.rs (line 9)

fn main() -> dialog::Result<()> {
    let choice = dialog::FileSelection::new("Please select a file")
        .title("File Chooser Example (Open)")
        .path("/etc")
        .show()?;
    println!("The user chose: {:?}", choice);

    let choice = dialog::FileSelection::new("Please select a file")
        .title("File Chooser Example (Save)")
        .mode(dialog::FileSelectionMode::Save)
        .path("/etc")
        .show()?;
    println!("The user chose: {:?}", choice);

    Ok(())
}

pub fn path_to_string(&self) -> Option<String>

Gets the path of this file chooser dialog box.

This method returns the validated directory as a String.

pub fn mode(&mut self, mode: FileSelectionMode) -> &mut FileSelection

Sets the operation mode of the file chooser.

This method returns a reference to self to enable chaining.

Examples found in repository

examples/file_selection.rs (line 15)

fn main() -> dialog::Result<()> {
    let choice = dialog::FileSelection::new("Please select a file")
        .title("File Chooser Example (Open)")
        .path("/etc")
        .show()?;
    println!("The user chose: {:?}", choice);

    let choice = dialog::FileSelection::new("Please select a file")
        .title("File Chooser Example (Save)")
        .mode(dialog::FileSelectionMode::Save)
        .path("/etc")
        .show()?;
    println!("The user chose: {:?}", choice);

    Ok(())
}

Trait Implementations

impl DialogBox for FileSelection

type Output = Option<String>

The type of the data returned by the dialog box.

fn show_with<B>(&self, backend: impl AsRef<B>) -> Result<Self::Output>

where B: Backend + ?Sized,

Shows this dialog box using the given backend and returns the output.

fn show(&self) -> Result<Self::Output>

Shows this dialog box using the default backend and returns the output.