implement refcounted byondvalue

Author: jupyterkat

crates/byondapi-rs/src/value/functions.rs

@@ -233,6 +233,7 @@ impl ByondValue {
 }
 
 /// # Refcount operations
+/// DO NOT USE, use [`super::refcounted::RcByondValue`] instead
 impl ByondValue {
     pub fn increment_ref(&mut self) {
         unsafe { byond().ByondValue_IncRef(&self.0) }

crates/byondapi-rs/src/value/mod.rs

@@ -5,6 +5,8 @@ use byondapi_sys::{ByondValueType, CByondValue};
 use crate::static_global::byond;
 
 /// [Newtype](https://doc.rust-lang.org/rust-by-example/generics/new_types.html) pattern over [`CByondValue`]
+/// WARNING: If this value is a ref created by byond passed to byondapi, it's a temp ref and will be deleted in a while
+/// Please convert it into a RcByondValue if you want byond to persist this ref
 #[repr(transparent)]
 #[derive(Clone, Copy)]
 pub struct ByondValue(pub CByondValue);
@@ -18,6 +20,7 @@ pub mod conversion;
 pub mod functions;
 pub mod list;
 pub mod pointer;
+pub mod refcounted;
 pub mod trait_impls;
 pub mod types;
 

crates/byondapi-rs/src/value/refcounted.rs

@@ -0,0 +1,34 @@
+use std::ops::{Deref, DerefMut};
+
+use super::ByondValue;
+
+/// Refcounted ByondValue, for refs you want rust to handle incrementing and decrementing.
+#[derive(Debug)]
+pub struct RcByondValue(ByondValue);
+
+impl From<ByondValue> for RcByondValue {
+    fn from(mut value: ByondValue) -> Self {
+        value.increment_ref();
+        RcByondValue(value)
+    }
+}
+
+impl Deref for RcByondValue {
+    type Target = ByondValue;
+    #[inline]
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl DerefMut for RcByondValue {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.0
+    }
+}
+
+impl Drop for RcByondValue {
+    fn drop(&mut self) {
+        self.0.decrement_ref();
+    }
+}