Merge pull request #81 from TheBlueMatt/main
[ldk-c-bindings] / lightning-c-bindings / src / lightning / util / ser.rs
index 511f3af2d4fb30dc9821055b31c1ddc276ee615b..da3023f365ac37757374212ebb697fc6bca3c666 100644 (file)
@@ -21,3 +21,77 @@ use alloc::{vec::Vec, boxed::Box};
 
 #[no_mangle]
 pub static MAX_BUF_SIZE: usize = lightning::util::ser::MAX_BUF_SIZE;
 
 #[no_mangle]
 pub static MAX_BUF_SIZE: usize = lightning::util::ser::MAX_BUF_SIZE;
+
+use lightning::util::ser::BigSize as nativeBigSizeImport;
+pub(crate) type nativeBigSize = nativeBigSizeImport;
+
+/// Lightning TLV uses a custom variable-length integer called BigSize. It is similar to Bitcoin's
+/// variable-length integers except that it is serialized in big-endian instead of little-endian.
+///
+/// Like Bitcoin's variable-length integer, it exhibits ambiguity in that certain values can be
+/// encoded in several different ways, which we must check for at deserialization-time. Thus, if
+/// you're looking for an example of a variable-length integer to use for your own project, move
+/// along, this is a rather poor design.
+#[must_use]
+#[repr(C)]
+pub struct BigSize {
+       /// A pointer to the opaque Rust object.
+
+       /// Nearly everywhere, inner must be non-null, however in places where
+       /// the Rust equivalent takes an Option, it may be set to null to indicate None.
+       pub inner: *mut nativeBigSize,
+       /// Indicates that this is the only struct which contains the same pointer.
+
+       /// Rust functions which take ownership of an object provided via an argument require
+       /// this to be true and invalidate the object pointed to by inner.
+       pub is_owned: bool,
+}
+
+impl Drop for BigSize {
+       fn drop(&mut self) {
+               if self.is_owned && !<*mut nativeBigSize>::is_null(self.inner) {
+                       let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
+               }
+       }
+}
+/// Frees any resources used by the BigSize, if is_owned is set and inner is non-NULL.
+#[no_mangle]
+pub extern "C" fn BigSize_free(this_obj: BigSize) { }
+#[allow(unused)]
+/// Used only if an object of this type is returned as a trait impl by a method
+pub(crate) extern "C" fn BigSize_free_void(this_ptr: *mut c_void) {
+       unsafe { let _ = Box::from_raw(this_ptr as *mut nativeBigSize); }
+}
+#[allow(unused)]
+impl BigSize {
+       pub(crate) fn get_native_ref(&self) -> &'static nativeBigSize {
+               unsafe { &*ObjOps::untweak_ptr(self.inner) }
+       }
+       pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeBigSize {
+               unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
+       }
+       /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
+       pub(crate) fn take_inner(mut self) -> *mut nativeBigSize {
+               assert!(self.is_owned);
+               let ret = ObjOps::untweak_ptr(self.inner);
+               self.inner = core::ptr::null_mut();
+               ret
+       }
+}
+#[no_mangle]
+pub extern "C" fn BigSize_get_a(this_ptr: &BigSize) -> u64 {
+       let mut inner_val = &mut this_ptr.get_native_mut_ref().0;
+       *inner_val
+}
+#[no_mangle]
+pub extern "C" fn BigSize_set_a(this_ptr: &mut BigSize, mut val: u64) {
+       unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.0 = val;
+}
+/// Constructs a new BigSize given each field
+#[must_use]
+#[no_mangle]
+pub extern "C" fn BigSize_new(mut a_arg: u64) -> BigSize {
+       BigSize { inner: ObjOps::heap_alloc(lightning::util::ser::BigSize (
+               a_arg,
+       )), is_owned: true }
+}