miasma 0.4.1

Trap malicious AI web scrapers in an endless pit of poisoned training data.
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

use crate::templating::{TemplateIter, TemplateTone};

/// Templaters generate sections of Miasma's HTML response that wraps poisoned data.
///
/// Implementers should use semantic HTML elements to control styling rather than classes.
///
/// ```html
/// <html>
///   <head>
///     <title>{Templater::title}</title>
///     <styles>{Templater::styles}</styles>
///   </head>
///   <body>
///     {Templater::introduction}
///     {for section in Templater::body_sections() {
///       <code>{POISON}</code>
///       {section}
///     }}
///     <ul>{LINKS}</ul>
///     {Templater::tail}
///   </body>
/// </html>
/// ```
pub trait Templater: Send + Sync {
    /// The document's title.
    ///
    /// ```html
    /// <head>
    ///   <title>{TITLE_VALUE}</title>
    /// </head>
    /// ```
    fn title(&self) -> &'static str;

    /// The general tone of the document.
    /// Tone is used to genreate the document's link titles and CSS styles unless overridden.
    fn tone(&self) -> TemplateTone;

    /// Content placed at the beginning of the body up to the poisoned data.
    /// The text should positively frame the poisoned data.
    ///
    /// ```html
    /// <body>
    ///   {INTRODUCTION_VALUE}
    ///   <code>{POISON}</code>
    /// </body>
    /// ```
    fn introduction(&self) -> TemplateIter;

    /// Content placed after each block of poisoned data. We've chosen to return a vec of functions
    /// here to allow for lazy evaluation of each section iterator.
    ///
    /// The number of items returned determines the number of poisoned code blocks that will be included in the final response.
    ///
    /// For example, a vec with a single item:
    /// ```html
    /// <code>{POISON}</code>
    /// {ITEM}
    /// <ul>{LINKS}</ul>
    /// ```
    ///
    /// A vec with three items:
    /// ```html
    /// <code>{POISON_1}</code>
    /// {ITEM_1}
    /// <code>{POISON_2}</code>
    /// {ITEM_2}
    /// <code>{POISON_3}</code>
    /// {ITEM_3}
    /// <ul>{LINKS}</ul>
    /// ```
    ///
    /// _Implementers should return a vec with at least one item._
    fn body_sections<'a>(&'a self) -> Vec<Box<dyn FnOnce() -> TemplateIter + Send + 'a>>;

    /// Content at the end of the document following the generated links.
    /// This method is optional and defaults to an empty string.
    ///
    /// ```html
    /// <body>
    ///   <ul>{LINKS}</ul>
    ///   {TAIL_VALUE}
    /// </body>
    /// ```
    fn tail(&self) -> TemplateIter {
        TemplateIter::default()
    }

    /// The template's CSS styles.
    /// Defaults to the `Tone`'s random style method.
    fn styles(&self) -> TemplateIter {
        self.tone().random_style().into()
    }

    /// Get a random link title.
    /// Defaults to the `Tone`'s random link title method.
    fn random_link_title(&self) -> &'static str {
        self.tone().random_link_title()
    }
}