Struct FileIcon

pub struct FileIcon {
    pub icon: char,
    pub color: &'static str,
}

The FileIcon struct contains the icon and color of a file type.

This struct is probably the only one you should interact with directly and is the preferred way to get the icon for a file. The icon field is a unicode character that corresponds to the correct icon for the file type (which can be printed to the terminal with fonts that support it, e.g. typically NerdFonts).

The color field is a hex color code that corresponds to the color of the icon. This can be used to color the icon in the terminal using your own method (e.g. ANSI escape codes, existing crates like termcolor etc.).

Example

use devicons::{FileIcon};

let icon = FileIcon::from("Cargo.toml");

println!("Icon: {} {}", icon.icon, icon.color);

Fields

icon: char

color: &'static str

Trait Implementations

impl Clone for FileIcon

fn clone(&self) -> FileIcon

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileIcon

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FileIcon

fn default() -> Self

Returns the “default value” for a type.

impl Display for FileIcon

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, P> From<P> for FileIcon

where P: AsRef<Path> + 'a,

fn from(path: P) -> FileIcon

Converts to this type from the input type.

impl Hash for FileIcon

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FileIcon

fn eq(&self, other: &FileIcon) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FileIcon

impl Eq for FileIcon

impl StructuralPartialEq for FileIcon