ph-curves 0.3.0

no-std, no-alloc Rust for embedded: curve lookup tables, ADC-to-measurement transfer functions with inverse and calibration, temporal filters, and tickless scheduling
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

//! Markdown-safe formatting for TOML-derived generated documentation.

// Host-only: module-local std link (crate root stays `#![no_std]`).
extern crate std;

use std::format;
use std::prelude::v1::*;

/// Debug-format one string, then neutralize Markdown and HTML punctuation.
pub(crate) fn markdown_debug(value: &str) -> String {
    let debug = format!("{value:?}");
    let mut escaped = String::with_capacity(debug.len());
    for character in debug.chars() {
        match character {
            '&' => escaped.push_str("&"),
            '<' => escaped.push_str("&lt;"),
            '>' => escaped.push_str("&gt;"),
            '`' | '*' | '_' | '{' | '}' | '[' | ']' => {
                escaped.push('\\');
                escaped.push(character);
            }
            _ => escaped.push(character),
        }
    }
    escaped
}

/// Debug-format user text for generated rustdoc without creating Markdown.
///
/// Ordinary punctuation uses backslash/HTML escaping to keep the historical
/// output stable. URLs and literal backticks use an inline-code fence longer
/// than every backtick run in the debug string; this also satisfies
/// `rustdoc::bare_urls` when warnings are denied.
pub(crate) fn rustdoc_debug(value: &str) -> String {
    if value.contains("://") || value.contains('`') {
        let debug = format!("{value:?}");
        let mut longest_run = 0;
        let mut current_run = 0;
        for character in debug.chars() {
            if character == '`' {
                current_run += 1;
                longest_run = longest_run.max(current_run);
            } else {
                current_run = 0;
            }
        }
        let fence = "`".repeat(longest_run + 1);
        format!("{fence}{debug}{fence}")
    } else {
        markdown_debug(value)
    }
}

#[cfg(test)]
mod tests {
    use super::{markdown_debug, rustdoc_debug};

    #[test]
    fn angle_brackets_use_html_entities() {
        assert_eq!(
            markdown_debug("<kPa> & <tag>"),
            r#""&lt;kPa&gt; &amp; &lt;tag&gt;""#
        );
        assert_eq!(rustdoc_debug("<kPa>"), r#""&lt;kPa&gt;""#);
    }
}