More rust cleanup

- Add extra info to README.md
- Refactor components api
- Add components unit test

Author: emesare

rust/README.md

@@ -13,6 +13,8 @@ These bindings are still actively under development. Compatibility _will_ break
 It is encouraged that you reference a specific commit to avoid having your plugin/application break when the API changes.
 To specify a specific commit see the cargo documentation [here](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choice-of-commit).
 
+If you are worried about breaking changes avoid modules with warnings about instability!
+
 **MSRV**: The Rust version specified in the `Cargo.toml`.
 
 ## Example

rust/src/binary_view.rs

@@ -25,7 +25,7 @@ use binaryninjacore_sys::*;
 
 use crate::architecture::{Architecture, CoreArchitecture};
 use crate::basic_block::BasicBlock;
-use crate::component::{Component, ComponentBuilder, IntoComponentGuid};
+use crate::component::{Component, IntoComponentGuid};
 use crate::confidence::Conf;
 use crate::data_buffer::DataBuffer;
 use crate::debuginfo::DebugInfo;
@@ -1422,39 +1422,35 @@ pub trait BinaryViewExt: BinaryViewBase {
             .collect()
     }
 
-    fn component_by_guid<S: BnStrCompatible>(&self, guid: S) -> Option<Component> {
+    fn component_by_guid<S: BnStrCompatible>(&self, guid: S) -> Option<Ref<Component>> {
         let name = guid.into_bytes_with_nul();
         let result = unsafe {
             BNGetComponentByGuid(
                 self.as_ref().handle,
                 name.as_ref().as_ptr() as *const c_char,
             )
         };
-        NonNull::new(result).map(|h| unsafe { Component::from_raw(h) })
+        NonNull::new(result).map(|h| unsafe { Component::ref_from_raw(h) })
     }
 
-    fn root_component(&self) -> Option<Component> {
+    fn root_component(&self) -> Option<Ref<Component>> {
         let result = unsafe { BNGetRootComponent(self.as_ref().handle) };
-        NonNull::new(result).map(|h| unsafe { Component::from_raw(h) })
+        NonNull::new(result).map(|h| unsafe { Component::ref_from_raw(h) })
     }
 
-    fn component_builder(&self) -> ComponentBuilder {
-        ComponentBuilder::new_from_raw(self.as_ref().handle)
-    }
-
-    fn component_by_path<P: BnStrCompatible>(&self, path: P) -> Option<Component> {
+    fn component_by_path<P: BnStrCompatible>(&self, path: P) -> Option<Ref<Component>> {
         let path = path.into_bytes_with_nul();
         let result = unsafe {
             BNGetComponentByPath(
                 self.as_ref().handle,
                 path.as_ref().as_ptr() as *const c_char,
             )
         };
-        NonNull::new(result).map(|h| unsafe { Component::from_raw(h) })
+        NonNull::new(result).map(|h| unsafe { Component::ref_from_raw(h) })
     }
 
     fn remove_component(&self, component: &Component) -> bool {
-        unsafe { BNRemoveComponent(self.as_ref().handle, component.as_raw()) }
+        unsafe { BNRemoveComponent(self.as_ref().handle, component.handle.as_ptr()) }
     }
 
     fn remove_component_by_guid<P: IntoComponentGuid>(&self, guid: P) -> bool {

rust/src/collaboration.rs

@@ -1,3 +1,5 @@
+//! The collaboration API is **unstable** and as such will undergo breaking changes in the near future!
+
 mod changeset;
 mod file;
 mod folder;