sl-types 0.2.3

Some basic types for Second Life related tools
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

//! Types related to SL chat

#[cfg(feature = "chumsky")]
use chumsky::{IterParser as _, Parser, text::digits};

/// represents a Second Life chat channel
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
#[expect(
    clippy::module_name_repetitions,
    reason = "this type is used outside of this module"
)]
pub struct ChatChannel(pub i32);

/// parse a chat channel
///
/// # Errors
///
/// returns an error if the string could not be parsed
#[cfg(feature = "chumsky")]
#[must_use]
#[expect(
    clippy::module_name_repetitions,
    reason = "this parser is used outside of this module"
)]
pub fn chat_channel_parser<'src>()
-> impl Parser<'src, &'src str, ChatChannel, chumsky::extra::Err<chumsky::error::Rich<'src, char>>>
{
    digits(10).collect::<String>().try_map(|d, span| {
        let d: i32 = d
            .parse()
            .map_err(|e| chumsky::error::Rich::custom(span, format!("{e:?}")))?;
        Ok(ChatChannel(d))
    })
}

impl std::fmt::Display for ChatChannel {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl std::str::FromStr for ChatChannel {
    type Err = <i32 as std::str::FromStr>::Err;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        <i32 as std::str::FromStr>::from_str(s).map(ChatChannel)
    }
}

/// the public chat channel on Second Life
pub const PUBLIC_CHANNEL: ChatChannel = ChatChannel(0);

/// the combat log event chat channel on Second Life
pub const COMBAT_CHANNEL: ChatChannel = ChatChannel(0x7FFF_FFFE);

/// the script debug chat channel on Second Life
pub const DEBUG_CHANNEL: ChatChannel = ChatChannel(0x7FFF_FFFF);

/// represents a Second Life chat volume
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, strum::EnumIs)]
#[expect(
    clippy::module_name_repetitions,
    reason = "this type is used outside of this module"
)]
pub enum ChatVolume {
    /// whisper (10m)
    Whisper,
    /// say (20m, default, a.k.a. chat range)
    Say,
    /// shout (100m)
    Shout,
    /// region say (the whole region)
    RegionSay,
}

impl ChatVolume {
    /// identify the chat volume of a message and strip it off the message
    #[must_use]
    pub fn volume_and_message(s: String) -> (Self, String) {
        if let Some(whisper_message) = s.strip_prefix("whispers: ") {
            (Self::Whisper, whisper_message.to_string())
        } else if let Some(shout_message) = s.strip_prefix("shouts: ") {
            (Self::Shout, shout_message.to_string())
        } else {
            (Self::Say, s)
        }
    }
}