Struct txtpp::Config

pub struct Config {
    pub base_dir: PathBuf,
    pub shell_cmd: String,
    pub inputs: Vec<String>,
    pub recursive: bool,
    pub num_threads: usize,
    pub mode: Mode,
    pub verbosity: Verbosity,
    pub trailing_newline: bool,
}

Config for running txtpp

Use this to configure txtpp when calling it from the library

Example

use txtpp::{Txtpp, Config, Verbosity};

// Use the default config
let mut cfg = Config::default();
// Change verbosity to verbose
cfg.verbosity = Verbosity::Verbose;
Txtpp::run(cfg).unwrap();

Fields

base_dir: PathBuf

Base directory for resolving paths in input. This is usually the current directory.

shell_cmd: String

The shell command to use. (e.g. bash -c). Empty string for platform-specific default shell

inputs: Vec<String>

The input file/directories

recursive: bool

Whether to recursively process directories

num_threads: usize

The number of threads to use

mode: Mode

The mode. See `Mode

verbosity: Verbosity

The verbosity. See Verbosity

trailing_newline: bool

If the output files should have trailing newline

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Get the default config.

This means:

• Running from the current directory
• Using the platform-specific default shell
• Processing the current directory
• Not recursively processing directories
• Using 4 threads
• Building output files
• Regular verbosity
• Output files have trailing newline