chore: upgrade safer_ffi to 0.1.0-rc1, with initial Doxygen-style \@C…

…lass annotation output and renaming. (#282)
subconsciousnetwork · Mar 22, 2023 · b18bc2d · b18bc2d
1 parent 4cd2e3a
commit b18bc2d
Show file tree

Hide file tree

Showing 11 changed files with 155 additions and 277 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/rust/noosphere/Cargo.toml b/rust/noosphere/Cargo.toml
@@ -65,7 +65,7 @@ features = [
 ]
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
-safer-ffi = { version = "~0.0.10", features = ["proc_macros", "out-refs"] }
+safer-ffi = { version = "0.1.0-rc1", features = ["proc_macros"] }
 tokio = { version = "^1", features = ["full"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dev-dependencies]

diff --git a/rust/noosphere/src/ffi/error.rs b/rust/noosphere/src/ffi/error.rs
@@ -4,7 +4,7 @@ use crate::error::NoosphereError;
 
 impl From<NoosphereError> for repr_c::Box<NsError> {
     fn from(error: NoosphereError) -> Self {
-        repr_c::Box::new(NsError { inner: error })
+        Box::new(NsError { inner: error }).into()
     }
 }
 
@@ -45,8 +45,11 @@ impl TryOrInitialize<repr_c::Box<NsError>> for Option<Out<'_, repr_c::Box<NsErro
     }
 }
 
-#[derive_ReprC]
-#[ReprC::opaque]
+#[derive_ReprC(rename = "ns_error")]
+#[repr(opaque)]
+/// @class ns_error_t
+///
+/// An error class.
 pub struct NsError {
     inner: NoosphereError,
 }

diff --git a/rust/noosphere/src/ffi/fs.rs b/rust/noosphere/src/ffi/fs.rs
@@ -23,8 +23,11 @@ use noosphere_sphere::{
     SphereContext, SphereCursor, SphereFile, SphereWalker,
 };
 
-#[derive_ReprC]
-#[ReprC::opaque]
+#[derive_ReprC(rename = "ns_sphere")]
+#[repr(opaque)]
+/// @class ns_sphere_t
+///
+/// A sphere class.
 pub struct NsSphere {
     inner: SphereCursor<
         Arc<Mutex<SphereContext<PlatformKeyMaterial, PlatformStorage>>>,
@@ -55,8 +58,11 @@ impl NsSphere {
     }
 }
 
-#[derive_ReprC]
-#[ReprC::opaque]
+#[derive_ReprC(rename = "ns_sphere_file")]
+#[repr(opaque)]
+/// @class ns_sphere_file_t
+///
+/// TBD
 pub struct NsSphereFile {
     inner: SphereFile<Pin<Box<dyn AsyncRead>>>,
 }
@@ -91,7 +97,7 @@ pub fn ns_sphere_fs_open(
 
             let cursor = SphereCursor::latest(sphere_context);
 
-            Ok(repr_c::Box::new(NsSphere { inner: cursor })) as Result<_, anyhow::Error>
+            Ok(Box::new(NsSphere { inner: cursor }).into()) as Result<_, anyhow::Error>
         })?;
 
         Ok(fs)
@@ -148,9 +154,10 @@ pub fn ns_sphere_fs_read(
                 let file = cursor.read(&slug).await?;
 
                 Ok(file.map(|sphere_file| {
-                    repr_c::Box::new(NsSphereFile {
+                    Box::new(NsSphereFile {
                         inner: sphere_file.boxed(),
                     })
+                    .into()
                 }))
             })
             .map_err(|error| error.into())
@@ -393,7 +400,8 @@ pub fn ns_sphere_file_header_value_first(
         .memo
         .get_first_header(name.to_str())
         .into_iter()
-        .filter_map(|value| value.try_into().ok()).next()
+        .filter_map(|value| value.try_into().ok())
+        .next()
 }
 
 #[ffi_export]