url-cleaner-engine 0.11.0

The engine behind URL Cleaner.
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

//! # [`Profiles`]
//!
//! Often you'll have only a handful of [`ParamsDiff`]s you want to switch between and share between multiple URL Cleaner Engine frontends (such as URL Cleaner Site and URL Cleaner Discord App).
//!
//! [`Profiles`] allow for this to be done with minimal performance hits.
//!
//! [`Profiles`] are created via a [`ProfilesConfig`], which in JSON looks like this:
//!
//! ```Json
//! {
//!   "base": {
//!     "params_diff": {
//!       "flags": ["flags", "to", "add", "for", "all", "profiles"]
//!     }
//!   },
//!   "profiles": {
//!     "additional_changes": {
//!       "params_diff": {
//!         "flags": ["flags to add", "for only this profile"]
//!       }
//!     }
//!   }
//! }
//! ```
//!
//! As stated in the above [`ProfilesConfig`], the [`ProfilesConfig::base`] [`ProfileConfig`] is applied to all profiles in the resulting [`ProfiledCleaner`].
//!
//! Each [`ProfileConfig`] in [`ProfilesConfig::profiles`] is then applied on top of the base profile.
//!
//! In the above example the `additional_changes` profile has the flags `["flags", "to", "add", "for", "all", "profiles", "flags to add", "for only this profile"]`.