refactor(rtc_tenclave,kv_store): pull out encode_to_fs_safe / decode_from_fs_safe

Author: PiDelport

rtc_tenclave/src/kv_store/fs/inspect.rs

@@ -9,6 +9,7 @@ use std::iter::Iterator;
 use serde::de::DeserializeOwned;
 use serde::Serialize;
 
+use crate::kv_store::fs::decode_from_fs_safe;
 use crate::kv_store::inspect::InspectStore;
 use crate::kv_store::KvStore;
 
@@ -33,7 +34,7 @@ where
                 .file_name()
                 .unwrap_or_else(|| panic!("directory entry lacks file_name: {:?}", file_path));
             let file_name: &str = os_file_name.to_str().expect("OsStr.to_str failed");
-            Self::decode_key(file_name).expect("FsStore::decode_key failed")
+            decode_from_fs_safe(file_name).expect("decode_from_fs_safe failed")
         });
 
         keys.map(|k| {

rtc_tenclave/src/kv_store/fs/mod.rs

@@ -57,27 +57,9 @@ where
 
     /// Resolve file name for the value of `key`.
     fn value_path(&self, key: &str) -> PathBuf {
-        let file_name = Self::encode_key(key);
+        let file_name = encode_to_fs_safe(key);
         self.root_dir.join(file_name)
     }
-
-    // Make keys filesystem-safe using hex (conservative, but effective):
-
-    pub(crate) fn encode_key(key: &str) -> String {
-        let encoded = hex::encode(key);
-        format!("x{}", encoded)
-    }
-
-    // FIXME: Just use a generic String as the error type, for now.
-    #[cfg_attr(not(test), allow(dead_code))] // currently only referenced in tests
-    pub(crate) fn decode_key(file_name: &str) -> Result<String, String> {
-        let encoded: &str = file_name
-            .strip_prefix("x")
-            .ok_or_else(|| format!("FsStore::decode_key: missing x prefix for {:?}", file_name))?;
-        let bytes: Vec<u8> = hex::decode(encoded).map_err(|err| err.to_string())?;
-        let decoded = String::from_utf8(bytes).map_err(|err| err.to_string())?;
-        Ok(decoded) //
-    }
 }
 
 impl<F, V> KvStore<V> for FsStore<F>
@@ -129,5 +111,23 @@ where
     }
 }
 
+/// Helper: Make `key` filesystem-safe.
+pub(crate) fn encode_to_fs_safe(key: &str) -> String {
+    let encoded = hex::encode(key);
+    format!("x{}", encoded)
+}
+
+/// Inverse of [`encode_to_fs_safe`].
+// FIXME: Just use a generic String as the error type, for now.
+#[cfg_attr(not(test), allow(dead_code))] // currently only referenced in tests
+pub(crate) fn decode_from_fs_safe(file_name: &str) -> Result<String, String> {
+    let encoded: &str = file_name
+        .strip_prefix("x")
+        .ok_or_else(|| format!("decode_from_fs_safe: missing x prefix for {:?}", file_name))?;
+    let bytes: Vec<u8> = hex::decode(encoded).map_err(|err| err.to_string())?;
+    let decoded = String::from_utf8(bytes).map_err(|err| err.to_string())?;
+    Ok(decoded)
+}
+
 #[cfg(test)]
 mod inspect;