Struct exa::Exa

pub struct Exa<'args, 'w, W: Write + 'w> {
    pub options: Options,
    pub writer: &'w mut W,
    pub args: Vec<&'args OsStr>,
    pub git: Option<GitCache>,
    pub ignore: Option<IgnoreCache>,
}

The main program wrapper.

Fields

options: Options

List of command-line options, having been successfully parsed.

writer: &'w mut W

The output handle that we write to. When running the program normally, this will be std::io::Stdout, but it can accept any struct that’s Write so we can write into, say, a vector for testing.

args: Vec<&'args OsStr>

List of the free command-line arguments that should correspond to file names (anything that isn’t an option).

git: Option<GitCache>

A global Git cache, if the option was passed in. This has to last the lifetime of the program, because the user might want to list several directories in the same repository.

ignore: Option<IgnoreCache>

A cache of git-ignored files. This lasts the lifetime of the program too, for the same reason.

Methods

impl<'args, 'w, W: Write + 'w> Exa<'args, 'w, W>

fn new<I>(args: I, writer: &'w mut W) -> Result<Exa<'args, 'w, W>, Misfire> where
    I: Iterator<Item = &'args OsString>, 

fn run(&mut self) -> IOResult<i32>