#string #parser-combinator #error-string #combination #permutation #parser #brace-expansion

bracoxide

A feature-rich library for brace pattern combination, permutation generation, and error handling

5 releases

0.1.4 Nov 10, 2024
0.1.3 Sep 20, 2023
0.1.2 Aug 7, 2023
0.1.1 Jul 20, 2023
0.1.0 Jun 21, 2023

#211 in Parser implementations

Download history 1848/week @ 2024-08-19 1860/week @ 2024-08-26 2116/week @ 2024-09-02 1794/week @ 2024-09-09 2061/week @ 2024-09-16 1724/week @ 2024-09-23 1736/week @ 2024-09-30 1696/week @ 2024-10-07 2219/week @ 2024-10-14 2013/week @ 2024-10-21 1970/week @ 2024-10-28 1811/week @ 2024-11-04 3088/week @ 2024-11-11 2127/week @ 2024-11-18 2138/week @ 2024-11-25 2332/week @ 2024-12-02

9,978 downloads per month
Used in 22 crates (2 directly)

MIT license

63KB
1K SLoC

{Bracoxide}

Tests License: MIT Contributor Covenant Documentation Bracoxide Crate

Bracoxide is a powerful Rust library for handling and expanding brace expansions. It provides a simple and intuitive way to generate combinations and permutations from brace patterns.

Features

  • Brace Expansion: Easily expand brace patterns into a list of all possible combinations.
  • Error Handling: Comprehensive error handling for invalid brace patterns or expansion failures.
  • MIT Licensed: Bracoxide is open-source and licensed under the MIT License.

Installation

Add Bracoxide to your Cargo.toml:

[dependencies]
bracoxide = "0.1.2"

Usage

Import the bracoxide crate and start expanding brace patterns:

use bracoxide::explode;

fn main() {
    let content = "foo{1..3}bar";
    match explode(content) {
        Ok(expanded) => {
            // [`foo1bar`, `foo2bar`, `foo3bar`]
            println!("Expanded patterns: {:?}", expanded);
        }
        Err(error) => {
            eprintln!("Error occurred: {:?}", error);
        }
    }
}

For more details and advanced usage, please refer to the API documentation.

Contributing

match contribution {
    /// found a bug or encountered an issue
    Contribution::Issue => redirect!("https://github.com/atahabaki/bracoxide/issues"),
    /// propose any changes
    Contribution::Change => redirect!("https://github.com/atahabaki/bracoxide/pulls"),
    /// have a question or need help
    Contribution::Ask => redirect!("https://github.com/atahabaki/bracoxide/discussions"),
}

Contributions are welcome! If you would like to contribute to this project, here are a few ways you can get involved:

  • Report Issues: If you encounter any issues or bugs, please let us know by creating an issue. Provide a detailed description of the problem, including steps to reproduce it if possible.
  • Propose Changes: If you have ideas for improvements or new features, we encourage you to submit a pull request. We appreciate your contributions and will review and consider them.
  • Ask Questions: If you have any questions or need help with the project, feel free to start a discussion. We'll be happy to assist you.

Please review our contribution guidelines for more detailed information on how to contribute effectively.

License

This project is licensed under the MIT License - see the LICENSE file for details.

No runtime deps