betlang 0.1.0

Tiny source-language detection for code.
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

#![warn(missing_docs)]
#![doc = include_str!("../README.md")]

mod language;
mod model;

pub use language::{Language, ParseLanguageError};

/// Source-language detection result.
///
/// Use [`Detection::language`] to read the top language and
/// [`Detection::top_languages`] to iterate over ranked probability/language
/// pairs. [`Detection::language`] returns [`None`] when the input is empty,
/// effectively whitespace only, or too short to build the model window.
///
/// ```
/// let detection = betlang::detect("fn main() { println!(\"hi\"); }");
///
/// assert_eq!(detection.language(), Some(betlang::Language::Rust));
/// ```
#[derive(Debug)]
pub struct Detection {
    predictions: Vec<(f32, Language)>,
}

impl Detection {
    /// Return the most likely detected language.
    ///
    /// Returns [`None`] when the input is empty, effectively whitespace only, or
    /// too short to build the model window.
    ///
    /// ```
    /// let detection = betlang::detect("fn main() { println!(\"hi\"); }");
    ///
    /// assert_eq!(detection.language(), Some(betlang::Language::Rust));
    /// ```
    pub fn language(&self) -> Option<Language> {
        self.predictions.first().map(|(_, language)| *language)
    }

    /// Return detected languages sorted from most likely to least likely.
    ///
    /// The iterator yields `(probability, language)` pairs, one per model
    /// output language.
    ///
    /// ```
    /// let detection = betlang::detect("fn main() { println!(\"hi\"); }");
    /// let Some((probability, language)) = detection.top_languages().next() else {
    ///     panic!("expected a language prediction");
    /// };
    ///
    /// assert_eq!(language, betlang::Language::Rust);
    /// assert!(probability > 0.0);
    /// ```
    pub fn top_languages(&self) -> impl Iterator<Item = (f32, Language)> + '_ {
        self.predictions.iter().copied()
    }

    pub(crate) fn from_predictions(predictions: Vec<(f32, Language)>) -> Self {
        Self { predictions }
    }
}

/// Detect the source language for bytes-like input.
///
/// Use [`Language::slug`] to read the model label slug. [`Detection::language`]
/// returns [`None`] when the input is empty, effectively whitespace only, or too
/// short to build the model window. The input may be a UTF-8 string, raw byte
/// slice, or another type that can be borrowed as bytes.
///
/// ```
/// let detection = betlang::detect("fn main() { println!(\"hi\"); }");
///
/// assert_eq!(detection.language(), Some(betlang::Language::Rust));
/// ```
pub fn detect(source: impl AsRef<[u8]>) -> Detection {
    model::detect(source.as_ref())
}