Struct Config 

pub struct Config { /* private fields */ }

Configuration struct for comparing two lines

Implementations

impl Config

pub fn from_cmd_args() -> Config

Create a config struct by using command line arguments

pub fn from_lines( sort: bool, lowercase: bool, separators: Vec<char>, l1: &str, l2: &str, ) -> Config

Create a Config struct that can be used to compare two lines that are given as &str

• sort Whether or not to sort chunks before comparing
• lowercase Whether or not to convert chunks to lowercase before comparing
• separators List of separators to use for splitting lines into chunks
• l1 The first line
• l2 The second line

Examples found in repository

examples/sort.rs (line 9)

fn main() -> Result<()> {
    println!("Example without sorting");
    let config = Config::from_lines(false, false, vec![' '], "Hello World", "World Hello");
    println!("{:?}", config);
    compare_lines(config)?;

    println!("Example with sorting");
    let config = Config::from_lines(true, false, vec![' '], "Hello World", "World Hello");
    println!("{:?}", config);
    compare_lines(config)
}

examples/lowercase.rs (line 9)

fn main() -> Result<()> {
    println!("Example without lowercase");
    let config = Config::from_lines(false, false, vec![' '], "Hello World", "Hello world");
    println!("{:?}", config);
    compare_lines(config)?;

    println!("Example with sorting");
    let config = Config::from_lines(false, true, vec![' '], "Hello World", "Hello world");
    println!("{:?}", config);
    compare_lines(config)
}

examples/separators.rs (line 9)

fn main() -> Result<()> {
    println!("Example without only ';' as separator");
    let config = Config::from_lines(false, false, vec![' '], "Hello;Wor ld", "Hello;Wor ld");
    println!("{:?}", config);
    compare_lines(config)?;

    println!("Example with ';' and ' ' as separators");
    let config = Config::from_lines(false, false, vec![' ', ';'], "Hello;Wor ld", "Hello;Wor ld");
    println!("{:?}", config);
    compare_lines(config)
}

examples/construction.rs (line 10)

fn main() -> Result<()> {
    println!("Example with two lines");
    let config = Config::from_lines(false, false, vec![' '], "Hello World", "hello World");
    println!("{:?}", config);
    compare_lines(config)?;

    println!("Example with using a single file containing two lines");
    let config = Config::from_file(
        false,
        false,
        vec![' '],
        PathBuf::from("examples/twolines.txt"),
    );
    println!("{:?}", config);
    compare_lines(config)
}

pub fn from_file( sort: bool, lowercase: bool, separators: Vec<char>, filepath: PathBuf, ) -> Config

Create a Config struct that can be used to compare two lines that are stored in a single file

• sort Whether or not to sort chunks before comparing
• lowercase Whether or not to convert chunks to lowercase before comparing
• separators List of separators to use for splitting lines into chunks
• filepath Path to the file that contains the two lines

Examples found in repository

examples/longlines.rs (lines 10-15)

fn main() -> Result<()> {
    println!("Example with using a single file containing two lines");
    let config = Config::from_file(
        false,
        false,
        vec![' '],
        PathBuf::from("examples/long-lines.txt"),
    );
    println!("{:?}", config);
    compare_lines(config)
}

examples/construction.rs (lines 15-20)

fn main() -> Result<()> {
    println!("Example with two lines");
    let config = Config::from_lines(false, false, vec![' '], "Hello World", "hello World");
    println!("{:?}", config);
    compare_lines(config)?;

    println!("Example with using a single file containing two lines");
    let config = Config::from_file(
        false,
        false,
        vec![' '],
        PathBuf::from("examples/twolines.txt"),
    );
    println!("{:?}", config);
    compare_lines(config)
}

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl StructOpt for Config

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error>

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making.