Function icon_for_file

pub fn icon_for_file<'a, F>(file: F, theme: &Option<Theme>) -> FileIcon
where
    F: Into<File<'a>>,

Get the icon for a file.

This function takes anything that might convert easily to a Path and an optional theme and returns a FileIcon struct.

The only real reason to use this function is if you want to specify a theme. If you don’t care about the theme, you can use the FileIcon::from trait implementation instead.

Example

use devicons::{icon_for_file, FileIcon, Theme};
use std::path::Path;

let path = Path::new("Cargo.toml");
let icon = icon_for_file(path, &Some(Theme::Dark));
println!("Icon: {} {}", icon.icon, icon.color);

Examples found in repository

examples/dark_theme.rs (line 9)

fn main() {
    // Create a new file instance for "example.txt"
    let path = Path::new("example.txt");

    // Get the icon for this file with the dark theme
    let icon = icon_for_file(path, &Some(Theme::Dark));

    // Print its corresponding icon
    println!("Filename: {}", path.to_string_lossy());
    println!("Icon: {}", icon.icon);
    println!("Color: {}", icon.color);
}

examples/default.rs (line 9)

fn main() {
    // Create a new file instance for a directory "my_folder/"
    let path = Path::new("my_folder/");

    // Get the icon for this directory with the default theme
    let icon = icon_for_file(path, &None);

    // Print its corresponding icon
    println!("Filename: {}", path.to_string_lossy());
    println!("Icon: {}", icon.icon);
    println!("Color: {}", icon.color);
}

examples/light_theme.rs (line 9)

fn main() {
    // Create a new file instance for a directory "my_folder/"
    let path = Path::new("my_folder/");

    // Get the icon for this directory with the light theme
    let icon = icon_for_file(path, &Some(Theme::Light));

    // Print its corresponding icon
    println!("Filename: {}", path.to_string_lossy());
    println!("Icon: {}", icon.icon);
    println!("Color: {}", icon.color);
}

examples/all.rs (line 7)

fn main() {
    // getting the icon from a path with a specified theme
    let path = Path::new("Cargo.toml");
    let icon_1 = icon_for_file(path, &Some(Theme::Dark));

    // getting the icon from a string with a specified theme
    let icon_2 = icon_for_file("Cargo.toml", &Some(Theme::Dark));

    // getting the icon from a path with the default theme
    let icon_3 = FileIcon::from(path);

    // directly getting an icon from a filename
    let icon_4 = FileIcon::from("Cargo.toml");

    // from a PathBuf
    let icon_5 = FileIcon::from(std::path::PathBuf::from("Cargo.toml"));

    // from a String
    let icon_6 = FileIcon::from("Cargo.toml".to_string());

    println!("File: {}", path.to_string_lossy());
    println!("Icon: {} {}", icon_1.icon, icon_1.color);
    println!("Icon: {} {}", icon_2.icon, icon_2.color);
    println!("Icon: {} {}", icon_3.icon, icon_3.color);
    println!("Icon: {} {}", icon_4.icon, icon_4.color);
    println!("Icon: {} {}", icon_5.icon, icon_5.color);
    println!("Icon: {} {}", icon_6.icon, icon_6.color);
}