Struct tokei::Config

pub struct Config {
    pub columns: Option<usize>,
    pub treat_doc_strings_as_comments: Option<bool>,
    pub types: Option<Vec<LanguageType>>,
}

A configuration struct for how Languages::get_statistics searches and counts languages.

use tokei::Config;

let config = Config {
    treat_doc_strings_as_comments: Some(true),
    ..Config::default()
};

Fields

columns: Option<usize>

Number columns to print. (Only used in the CLI).

treat_doc_strings_as_comments: Option<bool>

Whether to treat doc strings in languages as comments. By default this will be false.

types: Option<Vec<LanguageType>>

Filters languages searched to just those provided. E.g. A directory containing C, Cpp, and Rust with a Config.types of [Cpp, Rust] will count only Cpp and Rust.

Methods

impl Config

pub fn from_config_files() -> Self

Creates a Config from two configuration files if they are available. Files can have two different names tokei.toml and .tokeirc. Firstly it will attempt to find a config in the configuration directory (see below), and secondly from the current directory. The current directory's configuration will take priority over the configuration directory.

Platform	Value	Example
Linux	$XDG_DATA_HOME or $HOME/.local/share	/home/alice/.local/share
macOS	$HOME/Library/Application Support	/Users/Alice/Library/Application Support
Windows	{FOLDERID_RoamingAppData}	C:\Users\Alice\AppData\Roaming

Example

columns = 80
types = ["Python"]
treat_doc_strings_as_comments = true

Trait Implementations

impl Default for Config

fn default() -> Config

Returns the "default value" for a type.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where     __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.