sf6rs 0.3.5

A library for interfacing with various Street Figher 6 data forms.
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
100

extern crate regex;

use std::hash::{Hash, Hasher};
use std::sync::OnceLock;

use regex::Regex;
use crate::LazyLock;

pub static RYU: CharacterId = CharacterId::new("ryu", "Ryu", "ryu", r"ryu");
pub static LUKE: CharacterId = CharacterId::new("luke", "Luke", "luke", r"luke");
pub static JAMIE: CharacterId = CharacterId::new("jamie", "Jamie", "jamie", r"jamie");
pub static CHUNLI: CharacterId = CharacterId::new("chunli", "Chun-Li", "chunli", r"chun(-?li)?");
pub static GUILE: CharacterId = CharacterId::new("guile", "Guile", "guile", r"guile");
pub static KIMBERLY: CharacterId = CharacterId::new("kimberly", "Kimberly", "kimberly", r"kim(berly)?");
pub static JURI: CharacterId = CharacterId::new("juri", "Juri", "juri", r"juri");
pub static KEN: CharacterId = CharacterId::new("ken", "Ken", "ken", r"ken");
pub static BLANKA: CharacterId = CharacterId::new("blanka", "Blanka", "blanka", r"blanka");
pub static DHALSIM: CharacterId = CharacterId::new("dhalsim", "Dhalsim", "dhalsim", r"(dh?al)?sim");
pub static EHONDA: CharacterId = CharacterId::new("ehonda", "E.Honda", "ehonda", r"e?honda");
pub static DEEJAY: CharacterId = CharacterId::new("deejay", "Dee_Jay", "deejay", r"d(ee)?j(ay)?");
pub static MANON: CharacterId = CharacterId::new("manon", "Manon", "manon", r"manon");
pub static MARISA: CharacterId = CharacterId::new("marisa", "Marisa", "marisa", r"marisa");
pub static JP: CharacterId = CharacterId::new("jp", "JP", "jp", r"jp");
pub static ZANGIEF: CharacterId = CharacterId::new("zangief", "Zangief", "zangief", r"(zan)?gief");
pub static LILY: CharacterId = CharacterId::new("lily", "Lily", "lily", r"lily");
pub static CAMMY: CharacterId = CharacterId::new("cammy", "Cammy", "cammy", r"cammy");
pub static RASHID: CharacterId = CharacterId::new("rashid", "Rashid", "rashid", r"rashid");
pub static AKI: CharacterId = CharacterId::new("aki", "A.K.I.", "aki", r"a\.?k\.?i\.?");
pub static ED: CharacterId = CharacterId::new("ed", "Ed", "ed", r"ed");
pub static AKUMA: CharacterId = CharacterId::new("akuma", "Akuma", "akuma", r"akuma|gouki");
pub static MBISON: CharacterId = CharacterId::new("mbison", "M.Bison", "mbison", r"(m.?)?bison");

/// A collection of references to all the currently supported characters in this library
pub static CHARACTERS: LazyLock<Vec<&CharacterId>> = LazyLock::new(|| vec!(
    &RYU, &LUKE, &JAMIE, &CHUNLI, &GUILE, &KIMBERLY, &JURI, &KEN, &BLANKA, &DHALSIM, &EHONDA,
    &DEEJAY, &MANON, &MARISA, &JP, &ZANGIEF, &LILY, &CAMMY, &RASHID, &AKI, &ED, &AKUMA, &MBISON
));

/// Finds a character by matching against their regex
pub fn get_character_by_regex<'a>(input: &str) -> Option<&'a CharacterId> {
    CHARACTERS.iter().find(|c| c.regex().is_match(input)).copied()
}

/// Finds a character by matching against their id. Case sensitive.
pub fn get_character_by_id<'a>(input: &str) -> Option<&'a CharacterId> {
    CHARACTERS.iter().find(|c| c.id.eq(input)).copied()
}

/// A struct representing a character this library supports. Unique by `id`
#[derive(Clone, Debug)]
pub struct CharacterId {
    pub id: &'static str,
    pub frame_data_id: &'static str,
    pub gif_data_id: &'static str,
    regex_str: &'static str,
    regex_compiled: OnceLock<Regex>
}

impl CharacterId {
    const fn new(id: &'static str, frame_data_id: &'static str, gif_data_id: &'static str, regex: &'static str) -> Self {
        CharacterId {
            id,
            frame_data_id,
            gif_data_id,
            regex_str: regex,
            regex_compiled: OnceLock::new(),
        }
    }

    /// Gets the regex for this [`CharacterId`] via a [`OnceLock`]
    pub fn regex(&self) -> &Regex {
        self.regex_compiled.get_or_init(|| Regex::new(&format!(r"(?i)^{}$", self.regex_str)).unwrap())
    }

    /// Returns the url this library scrapes the data for each character
    pub fn frame_data_url(&self) -> String {
        format!("https://wiki.supercombo.gg/w/Street_Fighter_6/{}/Data", self.frame_data_id)
    }

    /// Returns the url this library scrapes the data for each character's move gifs
    pub fn gif_data_url(&self) -> String {
        format!("https://ultimateframedata.com/sf6/{}", self.gif_data_id)
    }
}

impl PartialEq<Self> for CharacterId {
    fn eq(&self, other: &Self) -> bool {
        self.id.eq(other.id)
    }
}

impl Eq for CharacterId {
    
}

impl Hash for CharacterId {
    fn hash<H: Hasher>(&self, state: &mut H) {
        state.write(self.id.as_ref())
    }
}