rustilities 3.0.1

This crate offers a few utils for Rust development
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
// SPDX-License-Identifier: GPL-3.0

use super::*;
use syn::{Attribute, ImplItem, Item, TraitItem, parse_quote};

#[test]
fn attrs_mut_item_const() {
	let mut item_const: Item = parse_quote! {
		/// Doc comment for const
		#[some_attr]
		const CONST: &str = "hello world";
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for const
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_const.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_enum() {
	let mut item_enum: Item = parse_quote! {
		/// Doc comment for enum
		#[some_attr]
		enum MyEnum { A, B }
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for enum
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_enum.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_extern_crate() {
	let mut item_extern: Item = parse_quote! {
		/// Doc comment for extern crate
		#[some_attr]
		extern crate my_crate;
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for extern crate
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_extern.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_fn() {
	let mut item_fn: Item = parse_quote! {
		/// Doc comment for function
		#[some_attr]
		fn my_function() {}
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for function
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_fn.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_foreign_mod() {
	let mut item_foreign: Item = parse_quote! {
		/// Doc comment for foreign mod
		#[some_attr]
		extern "C" {
			fn foreign_function();
		}
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for foreign mod
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_foreign.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_impl() {
	let mut item_impl: Item = parse_quote! {
		/// Doc comment for impl
		#[some_attr]
		impl MyTrait for MyStruct {}
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for impl
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_impl.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_macro() {
	let mut item_macro: Item = parse_quote! {
		/// Doc comment for macro
		#[some_attr]
		macro_rules! my_macro { () => {} }
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for macro
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_macro.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_mod() {
	let mut item_mod: Item = parse_quote! {
		/// Doc comment for module
		#[some_attr]
		mod my_mod {}
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for module
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_mod.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_static() {
	let mut item_static: Item = parse_quote! {
		/// Doc comment for static
		#[some_attr]
		static MY_STATIC: i32 = 42;
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for static
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_static.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_struct() {
	let mut item_struct: Item = parse_quote! {
		/// Doc comment for struct
		#[some_attr]
		struct MyStruct;
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for struct
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_struct.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_trait() {
	let mut item_trait: Item = parse_quote! {
		/// Doc comment for trait
		#[some_attr]
		trait MyTrait {}
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for trait
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_trait.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_trait_alias() {
	let mut item_trait_alias: Item = parse_quote! {
		/// Doc comment for trait alias
		#[some_attr]
		trait MyAlias = MyTrait;
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for trait alias
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_trait_alias.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_type() {
	let mut item_type: Item = parse_quote! {
		/// Doc comment for type
		#[some_attr]
		type MyType = u32;
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for type
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_type.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_union() {
	let mut item_union: Item = parse_quote! {
		/// Doc comment for union
		#[some_attr]
		union MyUnion { a: u32 }
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for union
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_union.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_use() {
	let mut item_use: Item = parse_quote! {
		/// Doc comment for use
		#[some_attr]
		use std::collections::HashMap;
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for use
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*item_use.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_item_verbatim() {
	let mut item_verbatim = Item::Verbatim(parse_quote! {
		/// Doc comment for impl const
		#[some_attr]
		const CONST: i32 = 1;
	});

	assert!(item_verbatim.attrs_mut().is_none());
}

#[test]
fn attrs_mut_impl_item_const() {
	let mut impl_item_const: ImplItem = parse_quote! {
		/// Doc comment for impl const
		#[some_attr]
		const CONST: i32 = 1;
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for impl const
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*impl_item_const.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_impl_item_fn() {
	let mut impl_item_fn: ImplItem = parse_quote! {
		/// Doc comment for impl fn
		#[some_attr]
		fn my_method(&self) {}
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for impl fn
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*impl_item_fn.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_impl_item_type() {
	let mut impl_item_type: ImplItem = parse_quote! {
		/// Doc comment for impl type
		#[some_attr]
		type MyType = u32;
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for impl type
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*impl_item_type.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_impl_item_macro() {
	let mut impl_item_macro: ImplItem = parse_quote! {
		/// Doc comment for impl macro
		#[some_attr]
		dummy! { () => {} }
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for impl macro
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*impl_item_macro.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_impl_item_verbatim() {
	let mut impl_item_verbatim = ImplItem::Verbatim(parse_quote! {
		/// Doc comment for impl const
		#[some_attr]
		const CONST: i32 = 1;
	});

	assert!(impl_item_verbatim.attrs_mut().is_none());
}

#[test]
fn attrs_mut_trait_item_const() {
	let mut trait_item_const: TraitItem = parse_quote! {
		/// Doc comment for trait const
		#[some_attr]
		const CONST: i32;
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for trait const
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*trait_item_const.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_trait_item_fn() {
	let mut trait_item_fn: TraitItem = parse_quote! {
		/// Doc comment for trait fn
		#[some_attr]
		fn my_method();
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for trait fn
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*trait_item_fn.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_trait_item_type() {
	let mut trait_item_type: TraitItem = parse_quote! {
		/// Doc comment for trait type
		#[some_attr]
		type MyType;
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for trait type
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*trait_item_type.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_trait_item_macro() {
	let mut trait_item_macro: TraitItem = parse_quote! {
		/// Doc comment for trait macro
		#[some_attr]
		dummy! { () => {} }
	};

	let expected_attrs: Vec<Attribute> = vec![
		parse_quote!(/// Doc comment for trait macro
		),
		parse_quote!(#[some_attr]),
	];

	assert_eq!(*trait_item_macro.attrs_mut().unwrap(), expected_attrs);
}

#[test]
fn attrs_mut_trait_item_verbatim() {
	let mut trait_item_verbatim = TraitItem::Verbatim(parse_quote! {
		/// Doc comment for impl const
		#[some_attr]
		const CONST: i32 = 1;
	});

	assert!(trait_item_verbatim.attrs_mut().is_none());
}

#[test]
fn tt_without_docs_tt_with_docs() {
	let tt: Item = parse_quote! {
		/// This is a doc comment that should be removed.
		#[some_attr]
		struct MyStruct;
	};

	let tt = tt_without_docs(&tt);

	let expected_tt: Item = parse_quote! {
		#[some_attr]
		struct MyStruct;
	};

	assert_eq!(tt, expected_tt);
}

#[test]
fn tt_without_docs_tt_without_docs() {
	let tt = Item::Verbatim(parse_quote! {
		/// This is a doc comment that should be removed.
		#[some_attr]
		struct MyStruct;
	});

	let output = tt_without_docs(&tt);

	assert_eq!(output, tt);
}

#[test]
fn tt_without_attrs_tt_with_attrs() {
	let tt: Item = parse_quote! {
		/// This is a doc comment that should be removed.
		#[some_attr]
		struct MyStruct;
	};

	let tt = tt_without_attrs(&tt);

	let expected_tt: Item = parse_quote! {
		struct MyStruct;
	};

	assert_eq!(tt, expected_tt);
}

#[test]
fn tt_without_attrs_tt_without_attrs() {
	let tt = Item::Verbatim(parse_quote! {
		/// This is a doc comment that should be removed.
		#[some_attr]
		struct MyStruct;
	});

	let output = tt_without_attrs(&tt);

	assert_eq!(output, tt);
}