xloc/
lib.rs

1//! # xloc
2//!
3//! - A fast, multi-threaded line counting utility. xloc hopes to speed up
4//! in places where other tools slow down.
5//! - An easy to use API is available through `xloc::App` if you would
6//! like to count lines/words from within another Rust project.
7//! - Simple and intuitive command line interface.
8//!
9//! ---
10//!
11//! #### Getting started from the command line
12//!
13//! ```bash
14//! ## Verify xloc is working.
15//! xloc --version
16//!
17//! ## Get help.
18//! xloc --help
19//!
20//! ## Count lines for all files in the current dir, with 1 job.
21//! xloc .
22//!
23//! ## Count words for all files in the current dir with nproc jobs.
24//! xloc -wj $(nproc) .
25//!
26//! ## Count words for 1 file, with 1 job.
27//! xloc -w test.txt
28//!
29//! ## Count lines for all files in the src dir, with 6 jobs.
30//! xloc -j 6 src
31//! ```
32//!
33//! ## Getting started in your own project
34//!
35//! Check out our documentation on `xloc::App` below.
36
37mod app;
38mod counter;
39mod threads;
40
41pub use app::App;