axis-core 1.1.1

AXIS-CORE SDK for programmatic web accessibility checking (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

//! # AXIS-CORE SDK
//!
//! A Rust library for automated web accessibility checking.
//!
//! ## Quick Start
//!
//! ```rust
//! use axis_core::AxisCore;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     let checker = AxisCore::new();
//!     let report = checker.check_url("https://example.com").await?;
//!
//!     println!("Accessibility Score: {}/100", report.accessibility_score);
//!     println!("Issues Found: {}", report.total_issues);
//!
//!     Ok(())
//! }
//! ```

pub mod models;
pub mod checker;
pub mod parser;

use crate::models::Report;
use crate::checker::AccessibilityChecker;
use crate::parser::HtmlParser;

/// Main AXIS-CORE SDK struct
pub struct AxisCore {
    checker: AccessibilityChecker,
    parser: HtmlParser,
}

impl AxisCore {
    /// Create a new AXIS-CORE checker instance
    pub fn new() -> Self {
        Self {
            checker: AccessibilityChecker::new(),
            parser: HtmlParser::new(),
        }
    }

    /// Check accessibility of a web page by URL
    ///
    /// # Example
    /// ```rust
    /// # use axis_core::AxisCore;
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let checker = AxisCore::new();
    /// let report = checker.check_url("https://example.com").await?;
    /// # Ok(())
    /// # }
    /// ```
    pub async fn check_url(&self, url: &str) -> Result<Report, Box<dyn std::error::Error>> {
        let load_result = self.parser.load_from_url(url).await?;
        let report = self.checker.check_accessibility(load_result);
        Ok(report)
    }

    /// Check accessibility of HTML content
    ///
    /// # Example
    /// ```rust
    /// # use axis_core::AxisCore;
    /// let checker = AxisCore::new();
    /// let html = r#"<html><body><img src="test.jpg" /></body></html>"#;
    /// let report = checker.check_html(html, None);
    /// // Missing alt text will be flagged
    /// ```
    pub fn check_html(&self, html: &str, base_url: Option<&str>) -> Report {
        let load_result = self.parser.parse_html(html, base_url);
        self.checker.check_accessibility(load_result)
    }

    /// Export a report to text format
    pub fn export_to_text(&self, report: &Report) -> String {
        self.checker.export_to_text(report)
    }

    /// Get the SDK version
    pub fn version() -> &'static str {
        env!("CARGO_PKG_VERSION")
    }
}

impl Default for AxisCore {
    fn default() -> Self {
        Self::new()
    }
}