hyperlit-base 0.1.0

A software documentation tool documentation embedded in source files - base 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
74

use arcstr::ArcStr;
use std::fmt::{Debug, Display};
use std::ops::Deref;

/// A shared, immutable threadsafe string
#[derive(Clone, Eq, Hash, PartialEq)]
pub struct SharedString {
    string: ArcStr,
}

impl SharedString {
    pub fn new(string: String) -> Self {
        Self {
            string: ArcStr::from(string),
        }
    }
}

impl AsRef<[u8]> for SharedString {
    fn as_ref(&self) -> &[u8] {
        self.string.as_bytes()
    }
}

impl AsRef<str> for SharedString {
    fn as_ref(&self) -> &str {
        self.string.as_str()
    }
}

impl Deref for SharedString {
    type Target = str;
    fn deref(&self) -> &str {
        self.string.as_str()
    }
}

impl From<String> for SharedString {
    fn from(string: String) -> Self {
        Self {
            string: ArcStr::from(string),
        }
    }
}

impl From<&str> for SharedString {
    fn from(string: &str) -> Self {
        Self::from(string.to_string())
    }
}

impl From<&SharedString> for SharedString {
    fn from(string: &SharedString) -> Self {
        string.clone()
    }
}

impl PartialEq<&str> for SharedString {
    fn eq(&self, other: &&str) -> bool {
        &self.string.as_str() == other
    }
}

impl Debug for SharedString {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Debug::fmt(&self.string, f)
    }
}

impl Display for SharedString {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Display::fmt(&self.string, f)
    }
}