tiny-clean 0.1.0

A lightweight, high-performance string sanitizer with configurable rules.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

use criterion::{Criterion, criterion_group, criterion_main};
use tiny_clean::java_script_encoder::{JavaScriptEncoder, JavaScriptEncoderMode};
use tiny_clean::uri_encoder::{UriEncoder, UriEncoderMode};
use tiny_clean::xml_encoder::{XmlEncoder, XmlEncoderMode};

fn xml_encode_benches(c: &mut Criterion) {
    let bench_data1 = std::fs::read_to_string("./benches/data/benchmark-data-1.txt").unwrap();
    let bench_data2 = std::fs::read_to_string("./benches/data/benchmark-data-2.txt").unwrap();
    let encoder = XmlEncoder::new(XmlEncoderMode::Attribute);
    c.bench_function("XmlEncoder - Attribute - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });
    c.bench_function("XmlEncoder - Attribute - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });
    let encoder = XmlEncoder::new(XmlEncoderMode::All);
    c.bench_function("XmlEncoder - All - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });
    c.bench_function("XmlEncoder - All - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });
    let encoder = XmlEncoder::new(XmlEncoderMode::Content);
    c.bench_function("XmlEncoder - Content - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });
    c.bench_function("XmlEncoder - Content - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });
    let encoder = XmlEncoder::new(XmlEncoderMode::SingleQuotedAttribute);
    c.bench_function("XmlEncoder - SingleQuotedAttribute - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });
    c.bench_function("XmlEncoder - SingleQuotedAttribute - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });
    let encoder = XmlEncoder::new(XmlEncoderMode::DoubleQuotedAttribute);
    c.bench_function("XmlEncoder - DoubleQuotedAttribute - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });
    c.bench_function("XmlEncoder - DoubleQuotedAttribute - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });
}

fn uri_encode_benches(c: &mut Criterion) {
    let bench_data1 = std::fs::read_to_string("./benches/data/benchmark-data-1.txt").unwrap();
    let bench_data2 = std::fs::read_to_string("./benches/data/benchmark-data-2.txt").unwrap();
    let encoder = UriEncoder::new(UriEncoderMode::FullUri);
    c.bench_function("UriEncoder - FullUri - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });
    let encoder = UriEncoder::new(UriEncoderMode::FullUri);
    c.bench_function("UriEncoder - FullUri - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });
    let encoder = UriEncoder::new(UriEncoderMode::Component);
    c.bench_function("UriEncoder - Component - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });
    let encoder = UriEncoder::new(UriEncoderMode::Component);
    c.bench_function("UriEncoder - Component - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });
}

fn java_script_encode_benches(c: &mut Criterion) {
    let bench_data1 = std::fs::read_to_string("./benches/data/benchmark-data-1.txt").unwrap();
    let bench_data2 = std::fs::read_to_string("./benches/data/benchmark-data-2.txt").unwrap();

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Block, true);
    c.bench_function("JavaScriptEncoder - Block - ASCII Only - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Block, false);
    c.bench_function("JavaScriptEncoder - Block - ASCII Extended - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Block, true);
    c.bench_function("JavaScriptEncoder - Block - ASCII Only - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Block, false);
    c.bench_function("JavaScriptEncoder - Block - ASCII Extended - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });

    ///////////// block end

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Source, true);
    c.bench_function("JavaScriptEncoder - Source - ASCII Only - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Source, false);
    c.bench_function("JavaScriptEncoder - Source - ASCII Extended - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Source, true);
    c.bench_function("JavaScriptEncoder - Source - ASCII Only - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Source, false);
    c.bench_function("JavaScriptEncoder - Source - ASCII Extended - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });

    ///////////// source end

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Html, true);
    c.bench_function("JavaScriptEncoder - Html - ASCII Only - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Html, false);
    c.bench_function("JavaScriptEncoder - Html - ASCII Extended - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Html, true);
    c.bench_function("JavaScriptEncoder - Html - ASCII Only - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Html, false);
    c.bench_function("JavaScriptEncoder - Html - ASCII Extended - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });

    ///////////// html end

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Attribute, true);
    c.bench_function("JavaScriptEncoder - Attribute - ASCII Only - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Attribute, false);
    c.bench_function("JavaScriptEncoder - Attribute - ASCII Extended - DS1", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data1)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Attribute, true);
    c.bench_function("JavaScriptEncoder - Attribute - ASCII Only - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });

    let encoder = JavaScriptEncoder::new(JavaScriptEncoderMode::Attribute, false);
    c.bench_function("JavaScriptEncoder - Attribute - ASCII Extended - DS2", |b| {
        b.iter(|| encoder.encode(std::hint::black_box(&bench_data2)))
    });

    ///////////// attribute end
}

criterion_group!{
    name = benches;
    config = Criterion::default().sample_size(60);
    targets = java_script_encode_benches,uri_encode_benches,xml_encode_benches
}
criterion_main!(benches);