Struct lscolors::LsColors

pub struct LsColors { /* fields omitted */ }

Holds information about how different file system entries should be colorized / styled.

Methods

impl LsColors

pub fn empty() -> Self

Construct an empty LsColors instance with no pre-defined styles.

pub fn from_env() -> Option<Self>

Creates a new LsColors instance from the LS_COLORS environment variable.

pub fn from_string(input: &str) -> Self

Creates a new LsColors instance from the given string.

pub fn style_for_path<P: AsRef<Path>>(&self, path: P) -> Option<&Style>

Get the ANSI style for a given path.

Note: this function calls Path::symlink_metadata internally. If you already happen to have the Metadata available, use style_for_path_with_metadata.

pub fn style_for_path_with_metadata<P: AsRef<Path>>(     &self,     path: P,     metadata: Option<&Metadata> ) -> Option<&Style>

Get the ANSI style for a path, given the corresponding Metadata struct.

Note: The Metadata struct must have been acquired via Path::symlink_metadata in order to colorize symbolic links correctly.

Important traits for StyledComponents<'a>

impl<'a> Iterator for StyledComponents<'a> type Item = (OsString, Option<&'a Style>);

pub fn style_for_path_components<'a>(     &'a self,     path: &'a Path ) -> StyledComponents<'a>

Get ANSI styles for each component of a given path. Components already include the path separator symbol, if required. For a path like foo/bar/test.md, this would return an iterator over three pairs for the three path components foo/, bar/ and test.md together with their respective styles.

pub fn style_for_indicator(&self, indicator: Indicator) -> Option<&Style>

Get the ANSI style for a certain Indicator (regular file, directory, symlink, ...). Note that this function implements a fallback logic for some of the indicators (just like ls). For example, the style for mi (missing file) falls back to or (orphaned symbolic link) if it has not been specified explicitly.

Trait Implementations

impl Default for LsColors

fn default() -> Self

Constructs a default LsColors instance with some default styles.

impl Clone for LsColors

fn clone(&self) -> LsColors

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LsColors

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

Formats the value using the given formatter.