quork 0.9.1

A collection of small things that don't deserve their own crate
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

//! A sized, stack allocated string type.
//!
//! This is useful for when you need a string to be stack allocated, but you also need it to be sized (i.e not a reference to a [`str`]).
//!
//! Especially when using shared memory this can be useful as the actual string will be stored in shared memory, rather than just the pointer to the string.

use core::{fmt::Debug, ops::Deref};

#[derive(Copy, Clone, PartialEq, Eq, Hash)]
/// A sized, stack allocated string type.
///
/// This is useful for when you need a string to be stack allocated, but you also need it to be sized (i.e not a reference to a [`str`]).
///
/// Especially when using shared memory this can be useful as the actual string will be stored in shared memory, rather than just the pointer to the string.
pub struct SizedString<const N: usize>([u8; N]);

impl<const N: usize> SizedString<N> {
    #[must_use]
    /// Construct a new [`SizedString`] from a byte array
    pub const fn new(bytes: [u8; N]) -> Self {
        Self(bytes)
    }

    #[must_use]
    /// Get the string as a [`str`]
    pub const fn as_str(&self) -> &str {
        unsafe { core::str::from_utf8_unchecked(&self.0) }
    }
}

impl<const N: usize> Deref for SizedString<N> {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        unsafe { core::str::from_utf8_unchecked(&self.0) }
    }
}

impl<const N: usize> AsRef<str> for SizedString<N> {
    fn as_ref(&self) -> &str {
        self
    }
}

impl<const N: usize, T> AsRef<T> for SizedString<N>
where
    str: core::convert::AsRef<T>,
{
    fn as_ref(&self) -> &T {
        let s: &str = self.as_ref();
        s.as_ref()
    }
}

impl<const N: usize> Debug for SizedString<N> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_tuple("SizedString").field(&self.as_str()).finish()
    }
}

#[cfg(test)]
mod tests {

    #[test]
    fn test_sized_string() {
        let s = quork_proc::sized_string!("hello world");

        let s_str: &str = s.as_ref();

        assert_eq!(s.len(), 11);
        assert_eq!(s_str, "hello world");
    }
}