Struct countroo::CountRoo

pub struct CountRoo {
    pub config: Config,
    pub total_lines: usize,
    pub num_files: usize,
    pub num_crates: usize,
    pub project_name: Option<String>,
    pub rust_edition: Option<String>,
    pub rustc_version: Option<String>,
    pub num_modules: usize,
}

CountRoo 🦘 - Your Rust Project’s Best Mate for Code Insights!

Embark on an adventure through your codebase with CountRoo, the struct that leaps across your files, counting lines of code, tracking crates, and more, all while keeping it fun! 🎉

Features

• Total Lines of Code 📊: Keeps track of the total lines across your project.
• Number of Files 🗂️: Counts the files explored in the code safari.
• Crate Count 📦: Tallies up the crates your project depends on.
• Project Name 🏷️: Captures the name of your project, if available.
• Rust Edition 🦀: Identifies the Rust edition your project is using.
• Rust Compiler Version 🔧: Determines the version of the Rust compiler (rustc) in use.
• Module Count 📚: Counts the number of modules within your Rust project.

Example

use countroo::prelude::*;
let config = Config::from_rel_file_path("path/to/config").unwrap();
let mut countroo = CountRoo::default();
let total_lines = countroo.count_lines_of_code().unwrap();
println!("Total lines of code: {}", total_lines);///

// Or you could just use macros for convenience such as count_some!() or count_it_all!()

Dive in and let CountRoo uncover the hidden gems and forgotten fossils in your codebase. Happy counting! 🚀

Fields

config: Config

total_lines: usize

num_files: usize

num_crates: usize

project_name: Option<String>

rust_edition: Option<String>

rustc_version: Option<String>

num_modules: usize

Implementations

impl CountRoo

pub fn count_lines_of_code(&mut self) -> Result<usize, LocCounterError>

pub fn count_lines_for_file( count_empty_lines: bool, entry: &String ) -> Result<usize, LocCounterError>

pub fn calculate_extension_counts(&self) -> HashMap<String, usize>

Calculates and aggregates the lines of code per occurrences of each file extension within the project’s source directory.

Arguments

• self: A reference to the current instance of the struct.

Returns

A HashMap where:

• Keys are strings representing unique file extensions found.
• Values are the corresponding counts of files with that extension.

Assumptions

• The config member of the struct holds relevant configuration data.
• config.count_empty_lines influences the counting behavior (Toggling it to true marks whitespace new lines as code lines).
• config.project_src_path defines the base directory for searching files (Usually src folder).

pub fn calculate_extension_counts_for( count_empty_lines: bool, path: &String ) -> HashMap<String, usize>

pub fn with_config_builder( config_builder: ConfigBuilder ) -> Result<Self, LocCounterError>

Trait Implementations

impl AllTypesCounter for CountRoo

fn count_lines_of_code_for_all_types( &mut self ) -> Result<usize, LocCounterError>

impl Analyzable for CountRoo

fn get_project_base(&self) -> String

fn is_code_file(&self, path: &str) -> bool

fn get_manifest(&self) -> Result<Manifest, LocCounterError>

fn count_code_files(&self, project_path: &str) -> Result<usize, LocCounterError>

fn count_crates(&self) -> Result<usize, LocCounterError>

fn get_project_name(&self) -> Result<Option<String>, LocCounterError>

fn get_rust_version() -> Option<String>

fn get_rust_edition(&self) -> Option<String>

fn count_rust_modules(project_path: &str) -> Result<usize, LocCounterError>

fn analyze_code_base(&mut self)

impl CertainTypesCounter for CountRoo

fn count_lines_of_code_for_certain_types( &mut self ) -> Result<usize, LocCounterError>

impl Debug for CountRoo

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

Formats the value using the given formatter.

impl Default for CountRoo

fn default() -> Self

Returns the “default value” for a type.

impl Display for CountRoo

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

Formats the value using the given formatter.

impl Exportable for CountRoo

fn export(&self, writer: Box<dyn OutputWriter>) -> Result<(), Error>