xloc
A fast, multi-threaded line counting utility written in Rust.
What is xloc
-
A drop in replacement for bash's
wc -l. -
Your project has x lines of code, xloc gets the value of x for you.
-
xloc is itended to be used from the command line. You can use it to count the number of lines in a file, or aggregate the total number of lines of all files in a directory.
-
While command line utility was the focus, a public API has also been made available to use in your own rust projects in the form of
xloc::App. -
By default xloc will ignore any directory named
targetor.git. This will likely be configurable at a later date.
Getting started
xloc supports Rust version 1.24.0 and greater.
For more information, read the API Reference.
Installation
From the command line
cargo install xloc
As a package dependency
# Cargo.toml
[dependencies]
xloc = "^0.1"
Usage
On the command line
# Count lines for all files in the current dir, with 1 job.
xloc .
# Count lines for 1 file, with 12 jobs.
xloc -j 12 test.txt
# Count lines for all files in the src dir, with 6 jobs.
xloc -j 6 src
In a file
// main.rs
use xloc::App;
fn main() {
// Create a mutable `App` using 1 job.
let mut app = App::new(1);
assert_eq!(app.get_njobs(), 1)
// Set the number of jobs to 12.
app.set_njobs(12);
assert_eq!(app.get_njobs(), 12);
// Recursively count lines in the current dir.
match app.count(".") {
Ok(count) => println!("{} lines", count),
Err(e) => println!("Error: {}", e),
}
License
The xloc crate for Rust is licensed under the BSD 3-Clause License.
19 Dec 7, 2022
5 Jan 9, 2023
198 Jan 2, 2023
2 Dec 5, 2022
5 Nov 3, 2022
12 Jan 21, 2023
3 Jul 30, 2023
314 Dec 18, 2022
458 Dec 27, 2022
15 Dec 26, 2022
11 Oct 30, 2022
10 Jun 17, 2022
4 May 5, 2022
6 May 6, 2022
41 Dec 17, 2022
11 Jul 27, 2022
7 Aug 21, 2022
1 Jan 22, 2022
1 Jan 25, 2022