More cleanup regarding BnString in the Rust API

- Removed `to_string` shortcut from `BnString`.
- Misc formatting

Author: emesare

plugins/dwarf/dwarf_import/src/dwarfdebuginfo.rs

@@ -622,7 +622,7 @@ impl DebugInfoBuilder {
                                 .items
                                 .len()
                         {
-                            func.full_name = Some(symbol_full_name.to_string());
+                            func.full_name = Some(symbol_full_name.to_string_lossy().to_string());
                         }
                     }
                 }

plugins/dwarf/dwarf_import/src/functions.rs

@@ -117,7 +117,7 @@ pub(crate) fn parse_function_entry<R: ReaderType>(
                 if let Ok(demangled) = sym.demangle(demangle_options) {
                     let cleaned = abi_regex.replace_all(&demangled, "");
                     let simplified = simplify_str_to_str(&cleaned);
-                    full_name = Some(simplified.to_string());
+                    full_name = Some(simplified.to_string_lossy().to_string());
                 }
             }
         }

plugins/dwarf/dwarf_import/src/lib.rs

@@ -234,6 +234,7 @@ fn recover_names_internal<R: ReaderType>(
                                 .collect::<Vec<String>>()
                                 .join("::"),
                         )
+                        .to_string_lossy()
                         .to_string(),
                     );
                 }
@@ -251,6 +252,7 @@ fn recover_names_internal<R: ReaderType>(
                                     .collect::<Vec<String>>()
                                     .join("::"),
                             )
+                            .to_string_lossy()
                             .to_string(),
                         );
                     }

plugins/warp/src/cache.rs

@@ -439,7 +439,7 @@ pub struct TypeRefID(u64);
 impl From<&BNNamedTypeReference> for TypeRefID {
     fn from(value: &BNNamedTypeReference) -> Self {
         let mut hasher = DefaultHasher::new();
-        hasher.write(value.id().to_bytes());
+        hasher.write(value.id().as_bytes());
         Self(hasher.finish())
     }
 }

plugins/warp/src/convert.rs

@@ -35,7 +35,7 @@ use warp::symbol::{Symbol, SymbolModifiers};
 pub fn from_bn_symbol(raw_symbol: &BNSymbol) -> Symbol {
     // TODO: Use this?
     let _is_export = raw_symbol.external();
-    let symbol_name = raw_symbol.raw_name().to_string();
+    let symbol_name = raw_symbol.raw_name().to_string_lossy().to_string();
     match raw_symbol.sym_type() {
         BNSymbolType::ImportAddress => {
             Symbol::new(

plugins/warp/src/plugin/copy.rs

@@ -14,8 +14,8 @@ impl FunctionCommand for CopyFunctionGUID {
         };
         let guid = cached_function_guid(func, &llil);
         log::info!(
-            "Function GUID for {}... {}",
-            func.symbol().short_name().to_string(),
+            "Function GUID for {:?}... {}",
+            func.symbol().short_name(),
             guid
         );
         if let Ok(mut clipboard) = arboard::Clipboard::new() {

rust/src/binary_view/memory_map.rs

@@ -21,13 +21,13 @@ impl MemoryMap {
     /// JSON string representation of the base [`MemoryMap`], consisting of unresolved auto and user segments.
     pub fn base_description(&self) -> String {
         let desc_raw = unsafe { BNGetBaseMemoryMapDescription(self.view.handle) };
-        unsafe { BnString::from_raw(desc_raw) }.to_string()
+        unsafe { BnString::into_string(desc_raw) }
     }
 
     /// JSON string representation of the [`MemoryMap`].
     pub fn description(&self) -> String {
         let desc_raw = unsafe { BNGetMemoryMapDescription(self.view.handle) };
-        unsafe { BnString::from_raw(desc_raw) }.to_string()
+        unsafe { BnString::into_string(desc_raw) }
     }
 
     // When enabled, the memory map will present a simplified, logical view that merges and abstracts virtual memory

rust/src/collaboration/remote.rs

@@ -167,7 +167,7 @@ impl Remote {
         &self,
         username: U,
         password: P,
-    ) -> Option<BnString> {
+    ) -> Option<String> {
         let username = username.to_cstr();
         let password = password.to_cstr();
         let token = unsafe {
@@ -180,7 +180,7 @@ impl Remote {
         if token.is_null() {
             None
         } else {
-            Some(unsafe { BnString::from_raw(token) })
+            Some(unsafe { BnString::into_string(token) })
         }
     }
 
@@ -226,7 +226,8 @@ impl Remote {
         };
         let username = options.username.to_cstr();
         let token = token.to_cstr();
-        let success = unsafe { BNRemoteConnect(self.handle.as_ptr(), username.as_ptr(), token.as_ptr()) };
+        let success =
+            unsafe { BNRemoteConnect(self.handle.as_ptr(), username.as_ptr(), token.as_ptr()) };
         success.then_some(()).ok_or(())
     }
 

rust/src/database.rs

@@ -147,10 +147,10 @@ impl Database {
     }
 
     /// Get a dictionary of all globals
-    pub fn globals(&self) -> HashMap<String, String> {
+    pub fn globals(&self) -> HashMap<String, BnString> {
         self.global_keys()
             .iter()
-            .filter_map(|key| Some((key.to_string(), self.read_global(key)?.to_string())))
+            .filter_map(|key| Some((key.to_string(), self.read_global(key)?)))
             .collect()
     }
 

rust/src/debuginfo.rs

@@ -319,6 +319,7 @@ unsafe impl CoreArrayProviderInner for DebugInfoParser {
 ///
 /// Functions will not be created if an address is not provided, but will be able to be queried from debug info for later user analysis.
 pub struct DebugFunctionInfo {
+    // TODO: These need to be BnString if we want to support invalid UTF-8
     short_name: Option<String>,
     full_name: Option<String>,
     raw_name: Option<String>,