Struct lscolors::LsColors

pub struct LsColors { /* private fields */ }

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

Implementations

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.

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

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

Trait Implementations

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.

impl Default for LsColors

fn default() -> Self

Constructs a default LsColors instance with some default styles.

impl PartialEq<LsColors> for LsColors

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for LsColors