");
15 | for _ in 0..rows {
16 | result.push_str("");
17 | for _ in 0..cols {
18 | result.push_str("| ");
19 | result.push_str(cell);
20 | result.push_str(" | ");
21 | }
22 | result.push_str("
");
23 | }
24 | result
25 | }
26 |
27 | #[bench]
28 | fn bench_empty(b: &mut Bencher) {
29 | b.iter(|| from_read(make_html("").as_bytes(), 80));
30 | }
31 |
32 | #[bench]
33 | fn bench_tab_1_1(b: &mut Bencher) {
34 | b.iter(|| from_read(make_html(&make_tab("cell", 1, 1)).as_bytes(), 80));
35 | }
36 | #[bench]
37 | fn bench_tab_2_2(b: &mut Bencher) {
38 | b.iter(|| from_read(make_html(&make_tab("cell", 2, 2)).as_bytes(), 80));
39 | }
40 | #[bench]
41 | fn bench_tab_3_3(b: &mut Bencher) {
42 | b.iter(|| from_read(make_html(&make_tab("cell", 3, 3)).as_bytes(), 80));
43 | }
44 | #[bench]
45 | fn bench_tab_4_4(b: &mut Bencher) {
46 | b.iter(|| from_read(make_html(&make_tab("cell", 4, 4)).as_bytes(), 80));
47 | }
48 | #[bench]
49 | fn bench_tab_5_5(b: &mut Bencher) {
50 | b.iter(|| from_read(make_html(&make_tab("cell", 5, 5)).as_bytes(), 80));
51 | }
52 | #[bench]
53 | fn bench_tab_6_6(b: &mut Bencher) {
54 | b.iter(|| from_read(make_html(&make_tab("cell", 6, 6)).as_bytes(), 80));
55 | }
56 | // Try a table with `depth` nested tables each with `rows` rows and `cols` columns.
57 | fn bench_tab_depth(b: &mut Bencher, content: &str, depth: usize, rows: usize, cols: usize) {
58 | let mut t = String::from(content);
59 | for _ in 0..depth {
60 | t = make_tab(&t, rows, cols);
61 | }
62 | let html = make_html(&t);
63 | b.iter(|| from_read(html.as_bytes(), 80));
64 | }
65 | #[bench]
66 | fn bench_tab_2_1_depth_2(b: &mut Bencher) {
67 | bench_tab_depth(b, "cell", 2, 2, 1);
68 | }
69 | #[bench]
70 | fn bench_tab_3_1_depth_2(b: &mut Bencher) {
71 | bench_tab_depth(b, "cell", 2, 3, 1);
72 | }
73 | #[bench]
74 | fn bench_tab_4_1_depth_2(b: &mut Bencher) {
75 | bench_tab_depth(b, "cell", 2, 4, 1);
76 | }
77 | #[bench]
78 | fn bench_tab_1_2_depth_2(b: &mut Bencher) {
79 | bench_tab_depth(b, "cell", 2, 1, 2);
80 | }
81 | #[bench]
82 | fn bench_tab_1_3_depth_2(b: &mut Bencher) {
83 | bench_tab_depth(b, "cell", 2, 1, 3);
84 | }
85 | #[bench]
86 | fn bench_tab_1_4_depth_2(b: &mut Bencher) {
87 | bench_tab_depth(b, "cell", 2, 1, 4);
88 | }
89 | #[bench]
90 | fn bench_tab_2_depth_2(b: &mut Bencher) {
91 | bench_tab_depth(b, "cell", 2, 2, 2);
92 | }
93 | /*
94 | #[bench]
95 | fn bench_tab_2_depth_3(b: &mut Bencher) {
96 | bench_tab_depth(b, "cell", 3, 2, 2);
97 | }
98 | #[bench]
99 | fn bench_tab_2_depth_4(b: &mut Bencher) {
100 | bench_tab_depth(b, "cell", 4, 2, 2);
101 | }
102 | #[bench]
103 | fn bench_tab_2_depth_5(b: &mut Bencher) {
104 | bench_tab_depth(b, "cell", 5, 2, 2);
105 | }
106 | */
107 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [](https://app.circleci.com/pipelines/github/jugglerchris/rust-html2text?filter=all)
2 |
3 | # html2text
4 |
5 | html2text is a [Rust](http://www.rust-lang.org/) crate which converts HTML to
6 | plain text (as in Rust `String`) or text spans with annotations like colours,
7 | e.g. optionally using CSS. See [the online demo](https://jugglerchris.github.io/rust-html2text/)
8 | for examples of the output.
9 |
10 | It makes use of the [Servo project](https://github.com/servo/servo)'s HTML
11 | parser, [html5ever](https://github.com/servo/html5ever/), using the DOM to
12 | generate text (which can optionally include annotations for some features such
13 | as hyperlinks).
14 |
15 | The project aims to do a reasonable job of rendering reasonable HTML in a
16 | terminal or other places where HTML needs to be converted to text (for
17 | example the text/plain fallback in HTML e-mails).
18 |
19 | With features (see below) some CSS/colour support is available.
20 |
21 | ## Examples
22 |
23 | The simple functions like `from_read()` return formatted text (in various
24 | formats including plain text).
25 |
26 | ```rust
27 | use html2text::from_read;
28 | let html = b"
29 |
30 | - Item one
31 | - Item two
32 | - Item three
33 |
";
34 | assert_eq!(from_read(&html[..], 20).unwrap(),
35 | "\
36 | * Item one
37 | * Item two
38 | * Item three
39 | ");
40 | ```
41 |
42 | A lower level API gives a bit more control. This give the same result (except for
43 | returning errors as Result instead of panicking):
44 |
45 | ```rust
46 | use html2text::config;
47 |
48 | let html = b"
49 |
50 | - Item one
51 | - Item two
52 | - Item three
53 |
";
54 |
55 | assert_eq!(
56 | config::plain()
57 | .string_from_read(&html[..], 20)
58 | .unwrap(),
59 | "\
60 | * Item one
61 | * Item two
62 | * Item three
63 | ");
64 | ```
65 |
66 | A couple of simple demonstration programs are included as examples:
67 |
68 | ### html2text
69 |
70 | The simplest example uses `from_read` to convert HTML on stdin into plain
71 | text:
72 |
73 | ```sh
74 | $ cargo run --example html2text < foo.html
75 | [...]
76 | ```
77 |
78 | ### html2term
79 |
80 | A very simple example of using the rich interface (`from_read_rich`) for a
81 | slightly interactive console HTML viewer is provided as `html2term`.
82 |
83 | ```sh
84 | $ cargo run --example html2term foo.html
85 | [...]
86 | ```
87 |
88 | Note that this example takes the HTML file as a parameter so that it can
89 | read keys from stdin.
90 |
91 | ## Cargo Features
92 |
93 | |Feature| Description|
94 | |-------|------------|
95 | |css | Limited handling of CSS, adding Coloured nodes to the render tree. |
96 | |html\_trace| Add verbose internal logging (not recommended) |
97 | |html\_trace\_bt| Add backtraces to the verbose internal logging |
98 |
99 | ### CSS support
100 |
101 | When the `css` feature is enabled, some simple CSS handling is available.
102 |
103 | Style rules are taken from:
104 | * If `Config::use_doc_css()` is called, then style from the document:
105 | * `
48 |
49 | Hi there
50 | This is some simple text with a link to github
51 |
52 | - Item one
53 | Item two- Item three
55 |
56 |
57 | | Heading 1 | Heading 2 | Heading 3 |
|---|
58 | | Data 1 | Data 2 | Data 3 |
59 | | Hello there |
60 |
61 |