accessibility-rs 0.1.7

Web accessibility engine for Rust.
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

use serde::{Deserialize, Serialize};

/// clip bounding box
#[derive(Default, Debug, Clone, Serialize, Deserialize)]
pub struct Clip {
    /// the x coords
    pub x: u32,
    /// the y coords
    pub y: u32,
    /// the element height
    pub height: u32,
    /// the element width
    pub width: u32,
}

/// Extra help information for the issue
#[derive(Default, Debug, Clone, Serialize, Deserialize)]
pub struct RunnerExtras {
    /// the url to get more information on the issue
    pub help_url: &'static str,
    /// a detailed description of the issue
    pub description: &'static str,
    /// the impact level criteria
    pub impact: &'static str,
}

/// Details of the problem
#[derive(Default, Debug, Clone, Serialize, Deserialize)]
pub struct Issue {
    /// the context of the issue or raw html
    pub context: String,
    /// the selector to identify the issue with css, xpath, or raw path
    pub selectors: Vec<String>,
    /// the type of code for the issue
    pub code: String,
    /// the type of issue
    pub issue_type: &'static str,
    /// the typecode of the issue 0,1,2
    pub type_code: u8,
    /// the message of the issue
    pub message: String,
    /// the type of runner
    pub runner: &'static str,
    /// extra details for the runner
    pub runner_extras: RunnerExtras,
    /// the amount of times the issue appeared
    pub recurrence: u32,
    /// the visual position of the element
    pub clip: Option<Clip>,
}

impl Issue {
    /// create a new issue
    pub fn new(
        message: String,
        context: &str,
        code: &str,
        issue_type: &'static str,
        selectors: Vec<String>,
    ) -> Issue {
        Issue {
            message,
            context: context.into(),
            runner: "accessibility-rs",
            code: code.into(),
            issue_type,
            type_code: match issue_type {
                "error" => 0,
                "warning" => 1,
                _ => 2,
            },
            selectors,
            ..Default::default()
        }
    }
}