rasn/types/strings/
visible.rs

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

rasn/types/strings/
visible.rs
