<commit_before>[![Build Status](https://travis-ci.org/Nicoretti/xxd-rs.svg?branch=master)](https://travis-ci.org/Nicoretti/xxd-rs)
[![Build status](https://ci.appveyor.com/api/projects/status/nki2w285pjq73jhk/branch/master?svg=true)](https://ci.appveyor.com/project/Nicoretti/xxd-rs/branch/master)
[![crates-io](https://img.shields.io/crates/v/xxd-rs.svg)](https://crates.io/crates/xxd-rs)

# xxd-rs
A rust based reimplementation of [<NAME>'s](<EMAIL>) hexdump utility, xxd.

## Mission statement
This project was created to learn rust, therefore there is no perf
If you wanna use the proect or contribute feel free, but please take note
of the goal(s) and non goals so you won't waste ur time or get frustrated.

### Goals
1. Learn rust
2. Provide a rust based replacement for xxd
3. Strive towards a clean rust code base
    - rustfmt
    - Add/refactor towards common rust idioms
4. Useability
    - Provide user friendly defaults
    - Provide clear and well documented command line tools
5. Continously improve the code base


### Non Goals
What this Project isn't about

1. Implement the fastest dump utility out there
    - If you are looking for a performant implementation of xxd
      checkout [go-xxd](https://github.com/felixge/go-xxd)

## Usage
```
USAGE:
    xxd-rs [OPTIONS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -i, --input-file <infile>      Input file which shall be used (default: stdin)
    -l, --length <length>          Amount of bytes which shall be read
    -o, --output-file <outfile>    File to which the output will be written (default: stdout)
    -s, --seek <seek>              Offset in the file where to start reading

SUBCOMMANDS:
    dump        Dumps an input file in the appropriate output format<commit_msg>Remove -i, --input-file parameter from README<commit_after>[![Build Status](https://travis-ci.org/Nicoretti/xxd-rs.svg?branch=master)](https://travis-ci.org/Nicoretti/xxd-rs)
[![Build status](https://ci.appveyor.com/api/projects/status/nki2w285pjq73jhk/branch/master?svg=true)](https://ci.appveyor.com/project/Nicoretti/xxd-rs/branch/master)
[![crates-io](https://img.shields.io/crates/v/xxd-rs.svg)](https://crates.io/crates/xxd-rs)

# xxd-rs
A rust based reimplementation of [<NAME>'s](<EMAIL>) hexdump utility, xxd.

## Mission statement
This project was created to learn rust, therefore there is no perf
If you wanna use the proect or contribute feel free, but please take note
of the goal(s) and non goals so you won't waste ur time or get frustrated.

### Goals
1. Learn rust
2. Provide a rust based replacement for xxd
3. Strive towards a clean rust code base
    - rustfmt
    - Add/refactor towards common rust idioms
4. Useability
    - Provide user friendly defaults
    - Provide clear and well documented command line tools
5. Continously improve the code base


### Non Goals
What this Project isn't about

1. Implement the fastest dump utility out there
    - If you are looking for a performant implementation of xxd
      checkout [go-xxd](https://github.com/felixge/go-xxd)

## Usage
```
USAGE:
    xxd-rs [OPTIONS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -l, --length <length>          Amount of bytes which shall be read
    -o, --output-file <outfile>    File to which the output will be written (default: stdout)
    -s, --seek <seek>              Offset in the file where to start reading

SUBCOMMANDS:
    dump        Dumps an input file in the appropriate output format
{'fraction_non_alphanumeric': 0.10760719225449517, 'fraction_numerical': 0.006639004149377593, 'mean_word_length': 3.3566265060240963, 'pattern_counts': {'":': 0, '<': 14, '<?xml version=': 0, '>': 14, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3536853', 'n_tokens_mistral': 1166, 'n_tokens_neox': 1137, 'n_words': 403}