3 releases

0.0.3 Apr 7, 2020
0.0.2 Apr 6, 2020
0.0.1 Mar 28, 2020

#1203 in Text processing

Download history 508/week @ 2024-11-16 660/week @ 2024-11-23 421/week @ 2024-11-30 549/week @ 2024-12-07 581/week @ 2024-12-14 69/week @ 2024-12-21 117/week @ 2024-12-28 863/week @ 2025-01-04 886/week @ 2025-01-11 384/week @ 2025-01-18 576/week @ 2025-01-25 512/week @ 2025-02-01 794/week @ 2025-02-08 731/week @ 2025-02-15 1065/week @ 2025-02-22 793/week @ 2025-03-01

3,492 downloads per month
Used in flex-rs

Apache-2.0

31KB
739 lines

No Comment

Version Minimum Rust version: 1.36

Remove comments from a char iterator.

This crate provides the WithoutComments iterator and the IntoWithoutComments trait implemented for all Iterator<Item=char> providing the without_comments method. Comment specifications are available for rust-style, c-style, python-style, and haskell-style line and block comments, a way to specify custom comment specifications is planned. This crate is intended to be used for removing comments from text, not from code, for this reason, "\*" will still open a block comment in rust mode because string literals have no semantic significance.

Usage

Add this to your Cargo.toml:

[dependencies]
without-comments = "0.0.3"

main.rs:

fn main() {
        use std::fs::read_to_string;
        use no_comment::{IntoWithoutComments as _, languages};

        let without_comments = read_to_string("tests.txt")
            .unwrap()
            .chars()
            .without_comments(languages::rust())
            .collect::<String>();

        println!("{}", without_comments);
}

test.txt:

This is text // this is a (rust) line comment
This is more text /* this is a (rust) block comment
/* this one is nested */ */
This is text again
/* If a comment is left open, it keeps
going until the end.

output:

This is text 
This is more text 
This is text again

Note that trailing spaces and newlines are preserved, showing whitespace the output looks like this:

This·is·text·¶
This·is·more·text·¶
This·is·text·again¶

Dependencies

~260–700KB
~16K SLoC