rasn/types/strings/
visible.rs

1use super::*;
2
3use crate::error::strings::InvalidIso646Character;
4use alloc::{borrow::ToOwned, boxed::Box, string::String, vec::Vec};
5use once_cell::race::OnceBox;
6
7/// A string which contains a subset of the ISO 646 character set.
8/// Type **should be** constructed by using `try_from` or `from` methods.
9///
10/// This type is restricted to allow only the graphically visible characters and space character (0x20),
11/// which is defined in X.680 (02/2021), Section 41, Table 8.
12///
13/// Should contain registration 6. set from ISO International Register of Coded Character Sets and SPACE character.
14/// Graphical restrictions (registration 6.) are defined freely and publicly in sister standard ITU-T T.50, section 6.4.
15#[derive(Debug, Default, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
16#[allow(clippy::module_name_repetitions)]
17pub struct VisibleString(Vec<u8>);
18static CHARACTER_MAP: OnceBox<alloc::collections::BTreeMap<u32, u32>> = OnceBox::new();
19static INDEX_MAP: OnceBox<alloc::collections::BTreeMap<u32, u32>> = OnceBox::new();
20
21impl VisibleString {
22    /// Create a new `VisibleString` from ISO 646 bytes (also known as US-ASCII/IA5/IRA5).
23    ///
24    /// # Errors
25    ///
26    /// Error of type `InvalidIso646Bytes` is raised if the restriction is not met.
27    pub fn from_iso646_bytes(bytes: &[u8]) -> Result<Self, InvalidIso646Character> {
28        bytes.iter().try_for_each(|byte| {
29            if Self::CHARACTER_SET.contains(&(*byte as u32)) {
30                Ok(())
31            } else {
32                Err(InvalidIso646Character { character: *byte })
33            }
34        })?;
35
36        Ok(Self(bytes.to_owned()))
37    }
38    /// Converts the `VisibleString` into ISO 646 bytes (also known as US-ASCII/IA5/IRA5).
39    #[must_use]
40    pub fn as_iso646_bytes(&self) -> &[u8] {
41        &self.0
42    }
43}
44
45impl StaticPermittedAlphabet for VisibleString {
46    /// Includes Space (0x20) and all graphically visible characters (0x21-0x7E).
47    const CHARACTER_SET: &'static [u32] = &[
48        0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E,
49        0x2F, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, 0x3C, 0x3D,
50        0x3E, 0x3F, 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4A, 0x4B, 0x4C,
51        0x4D, 0x4E, 0x4F, 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x5B,
52        0x5C, 0x5D, 0x5E, 0x5F, 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6A,
53        0x6B, 0x6C, 0x6D, 0x6E, 0x6F, 0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79,
54        0x7A, 0x7B, 0x7C, 0x7D, 0x7E,
55    ];
56
57    fn chars(&self) -> Box<dyn Iterator<Item = u32> + '_> {
58        Box::from(self.0.iter().map(|byte| *byte as u32))
59    }
60
61    #[track_caller]
62    fn push_char(&mut self, ch: u32) {
63        debug_assert!(
64            Self::CHARACTER_SET.contains(&ch),
65            "{} not in character set",
66            ch
67        );
68        self.0.push(ch as u8);
69    }
70
71    fn index_map() -> &'static alloc::collections::BTreeMap<u32, u32> {
72        INDEX_MAP.get_or_init(Self::build_index_map)
73    }
74
75    fn character_map() -> &'static alloc::collections::BTreeMap<u32, u32> {
76        CHARACTER_MAP.get_or_init(Self::build_character_map)
77    }
78}
79
80impl core::fmt::Display for VisibleString {
81    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
82        f.write_str(&String::from_utf8(self.as_iso646_bytes().to_owned()).unwrap())
83    }
84}
85
86impl AsnType for VisibleString {
87    const TAG: Tag = Tag::VISIBLE_STRING;
88}
89
90impl Encode for VisibleString {
91    fn encode_with_tag_and_constraints<E: Encoder>(
92        &self,
93        encoder: &mut E,
94        tag: Tag,
95        constraints: Constraints,
96    ) -> Result<(), E::Error> {
97        encoder
98            .encode_visible_string(tag, constraints, self)
99            .map(drop)
100    }
101}
102
103impl Decode for VisibleString {
104    fn decode_with_tag_and_constraints<D: Decoder>(
105        decoder: &mut D,
106        tag: Tag,
107        constraints: Constraints,
108    ) -> Result<Self, D::Error> {
109        decoder.decode_visible_string(tag, constraints)
110    }
111}
112
113impl TryFrom<alloc::string::String> for VisibleString {
114    type Error = InvalidIso646Character;
115
116    fn try_from(value: alloc::string::String) -> Result<Self, Self::Error> {
117        Self::from_iso646_bytes(value.as_bytes())
118    }
119}
120
121impl TryFrom<&'_ str> for VisibleString {
122    type Error = InvalidIso646Character;
123
124    fn try_from(value: &str) -> Result<Self, Self::Error> {
125        Self::from_iso646_bytes(value.as_bytes())
126    }
127}
128
129impl TryFrom<alloc::vec::Vec<u8>> for VisibleString {
130    type Error = InvalidIso646Character;
131
132    fn try_from(value: alloc::vec::Vec<u8>) -> Result<Self, Self::Error> {
133        Self::from_iso646_bytes(&value)
134    }
135}
136
137impl TryFrom<&'_ [u8]> for VisibleString {
138    type Error = InvalidIso646Character;
139
140    fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
141        Self::from_iso646_bytes(value)
142    }
143}
144
145impl TryFrom<bytes::Bytes> for VisibleString {
146    type Error = InvalidIso646Character;
147
148    fn try_from(value: bytes::Bytes) -> Result<Self, Self::Error> {
149        Self::try_from(&*value)
150    }
151}
152
153impl From<VisibleString> for bytes::Bytes {
154    fn from(value: VisibleString) -> Self {
155        value.0.into()
156    }
157}
158
159impl From<VisibleString> for alloc::string::String {
160    fn from(value: VisibleString) -> Self {
161        Self::from_utf8(value.as_iso646_bytes().to_owned()).unwrap()
162    }
163}
rasn/types/strings/visible.rs

rasn/types/strings/
visible.rs
