xref: /DADK/dadk-config/src/rootfs/utils/size.rs (revision c9f71754563759e653d59a110f15298891564be9)
1 use serde::Deserializer;
2 
3 use crate::rootfs::RootFSConfigFile;
4 
5 /// 自定义反序列化函数,用于解析表示磁盘镜像大小的值。
6 ///
7 /// 此函数支持两种输入格式:
8 /// 1. 纯数字:直接将其视为字节数。
9 /// 2. 带单位的字符串:如"1M"、"1G",其中单位支持K(千字节)、M(兆字节)、G(千兆字节)。
10 ///
11 /// 函数将输入值解析为`usize`类型,表示字节数。
12 ///
13 /// # 参数
14 /// - `deserializer`: 一个实现了`Deserializer` trait的对象,用于读取和解析输入数据。
15 ///
16 /// # 返回值
17 /// 返回一个`Result<usize, D::Error>`,其中:
18 /// - `Ok(usize)`表示解析成功,返回对应的字节数。
19 /// - `Err(D::Error)`表示解析失败,返回错误信息。
20 ///
21 /// # 错误处理
22 /// - 如果输入是非法的字符串(无法解析或单位不合法),将返回自定义错误。
23 /// - 如果输入类型既不是整数也不是字符串,将返回类型错误。
24 pub fn deserialize_size<'de, D>(deserializer: D) -> Result<usize, D::Error>
25 where
26     D: Deserializer<'de>,
27 {
28     // 使用serde的deserialize_any方法来处理不同类型的输入
29     let value = serde::de::Deserialize::deserialize(deserializer)?;
30 
31     // 匹配输入值的类型,进行相应的转换
32     let r = match value {
33         toml::Value::Integer(num) => {
34             // 如果是整数类型,直接转换成usize
35             Ok(num as usize)
36         }
37         toml::Value::String(s) => {
38             // 如果是字符串类型,解析如"1M"这样的表示
39             parse_size_from_string(&s)
40                 .ok_or_else(|| serde::de::Error::custom("Invalid string for size"))
41         }
42         _ => Err(serde::de::Error::custom("Invalid type for size")),
43     };
44 
45     r.map(|size| (size + RootFSConfigFile::LBA_SIZE - 1) & !(RootFSConfigFile::LBA_SIZE - 1))
46 }
47 
48 /// Parses a size string with optional unit suffix (K, M, G) into a usize value.
49 ///
50 /// This function takes a string that represents a size, which can be a plain
51 /// number or a number followed by a unit suffix (K for kilobytes, M for megabytes,
52 /// G for gigabytes). It converts this string into an equivalent usize value in bytes.
53 ///
54 /// # Parameters
55 /// - `size_str`: A string slice that contains the size to parse. This can be a simple
56 ///   numeric string or a numeric string followed by a unit ('K', 'M', 'G').
57 ///
58 /// # Returns
59 /// An `Option<usize>` where:
60 /// - `Some(usize)` contains the parsed size in bytes if the input string is valid.
61 /// - `None` if the input string is invalid or contains an unsupported unit.
62 fn parse_size_from_string(size_str: &str) -> Option<usize> {
63     if size_str.chars().all(|c| c.is_ascii_digit()) {
64         // 如果整个字符串都是数字,直接解析返回
65         return size_str.parse::<usize>().ok();
66     }
67 
68     let mut chars = size_str.chars().rev();
69     let unit = chars.next()?;
70     let number_str: String = chars.rev().collect();
71     let number = number_str.parse::<usize>().ok()?;
72 
73     match unit.to_ascii_uppercase() {
74         'K' => Some(number * 1024),
75         'M' => Some(number * 1024 * 1024),
76         'G' => Some(number * 1024 * 1024 * 1024),
77         _ => None,
78     }
79 }
80 
81 #[cfg(test)]
82 mod tests {
83     use super::*;
84 
85     #[test]
86     fn test_parse_size_from_string() {
87         // 正常情况,不带单位
88         assert_eq!(parse_size_from_string("1024"), Some(1024));
89 
90         // 正常情况,带有单位
91         assert_eq!(parse_size_from_string("1K"), Some(1024));
92         assert_eq!(parse_size_from_string("2M"), Some(2 * 1024 * 1024));
93         assert_eq!(parse_size_from_string("3G"), Some(3 * 1024 * 1024 * 1024));
94 
95         // 边界情况
96         assert_eq!(parse_size_from_string("0K"), Some(0));
97         assert_eq!(parse_size_from_string("0M"), Some(0));
98         assert_eq!(parse_size_from_string("0G"), Some(0));
99 
100         // 小写情况
101         assert_eq!(parse_size_from_string("1k"), Some(1024));
102         assert_eq!(parse_size_from_string("2m"), Some(2 * 1024 * 1024));
103         assert_eq!(parse_size_from_string("3g"), Some(3 * 1024 * 1024 * 1024));
104 
105         // 错误的单位
106         assert_eq!(parse_size_from_string("1T"), None);
107         assert_eq!(parse_size_from_string("2X"), None);
108 
109         // 错误的数字格式
110         assert_eq!(parse_size_from_string("aK"), None);
111         assert_eq!(parse_size_from_string("1.5M"), None);
112 
113         // 空字符串
114         assert_eq!(parse_size_from_string(""), None);
115 
116         // 只单位没有数字
117         assert_eq!(parse_size_from_string("K"), None);
118 
119         // 数字后有多余字符
120         assert_eq!(parse_size_from_string("1KextrK"), None);
121     }
122 }
123