update value-box readme

syrel · syrel · commit aeac23b2ec1d · 2023-01-26T11:23:47.000+01:00
diff --git a/value-box/Cargo.toml b/value-box/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "value-box"
-version = "2.2.0"
+version = "2.2.1"
 authors = ["feenk gmbh <contact@feenk.com>"]
 edition = "2021"
 repository = "https://github.com/feenkcom/boxes-rs/tree/main/value-box"
diff --git a/value-box/README.md b/value-box/README.md
@@ -29,19 +29,28 @@ pub fn library_object_create() -> *mut ValueBox<MyObject> {
 #[no_mangle]
 pub fn library_object_is_something(object: *mut ValueBox<MyObject>) -> bool {
     object
-        .to_ref()
-        .map(|object| object.is_something())
+        // with_ref_ok() wraps the returned value into Result:Ok,
+        // hence the name
+        .with_ref_ok(|object| object.is_something())
         .unwrap_or(false)
 }
 
+#[no_mangle]
+pub fn library_object_try_something(object: *mut ValueBox<MyObject>) {
+    object
+        // with_ref() expects the closure to return a Result
+        .with_ref(|object| object.try_something())
+        .log();
+}
+
 #[no_mangle]
 pub fn library_object_by_ref(object: *mut ValueBox<MyObject>) {
-    object.to_ref().map(|object| object.by_ref()).log();
+    object.with_ref_ok(|object| object.by_ref()).log();
 }
 
 #[no_mangle]
 pub fn library_object_by_mut(object: *mut ValueBox<MyObject>) {
-    object.to_ref().map(|mut object| object.by_mut()).log();
+    object.with_mut_ok(|mut object| object.by_mut()).log();
 }
 
 #[no_mangle]
@@ -52,8 +61,7 @@ pub fn library_object_by_value(object: *mut ValueBox<MyObject>) {
 #[no_mangle]
 pub fn library_object_by_value_clone(object: *mut ValueBox<MyObject>) {
     object
-        .to_ref()
-        .map(|object| object.clone().by_value())
+        .with_clone_ok(|object| object.by_value())
         .log();
 }
 
@@ -75,5 +83,8 @@ impl MyObject {
     pub fn is_something(&self) -> bool {
         true
     }
+    pub fn try_something(&self) -> Result<()> {
+        Ok(())
+    }
 }
 ```
