Update auto-generated bindings
[ldk-c-bindings] / lightning-c-bindings / src / lightning / util / ser.rs
index 511f3af2d4fb30dc9821055b31c1ddc276ee615b..824dc7a06aae64973883bb22bb66e3b9c3068a0d 100644 (file)
@@ -7,7 +7,10 @@
 // source was automatically generated.
 
 //! A very simple serialization framework which is used to serialize/deserialize messages as well
-//! as ChannelsManagers and ChannelMonitors.
+//! as [`ChannelManager`]s and [`ChannelMonitor`]s.
+//!
+//! [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
+//! [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
 
 use alloc::str::FromStr;
 use core::ffi::c_void;
@@ -21,3 +24,170 @@ use alloc::{vec::Vec, boxed::Box};
 
 #[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) {
+       let _ = unsafe { 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 }
+}
+
+use lightning::util::ser::Hostname as nativeHostnameImport;
+pub(crate) type nativeHostname = nativeHostnameImport;
+
+/// Represents a hostname for serialization purposes.
+/// Only the character set and length will be validated.
+/// The character set consists of ASCII alphanumeric characters, hyphens, and periods.
+/// Its length is guaranteed to be representable by a single byte.
+/// This serialization is used by [`BOLT 7`] hostnames.
+///
+/// [`BOLT 7`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md
+#[must_use]
+#[repr(C)]
+pub struct Hostname {
+       /// 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 nativeHostname,
+       /// 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 Hostname {
+       fn drop(&mut self) {
+               if self.is_owned && !<*mut nativeHostname>::is_null(self.inner) {
+                       let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
+               }
+       }
+}
+/// Frees any resources used by the Hostname, if is_owned is set and inner is non-NULL.
+#[no_mangle]
+pub extern "C" fn Hostname_free(this_obj: Hostname) { }
+#[allow(unused)]
+/// Used only if an object of this type is returned as a trait impl by a method
+pub(crate) extern "C" fn Hostname_free_void(this_ptr: *mut c_void) {
+       let _ = unsafe { Box::from_raw(this_ptr as *mut nativeHostname) };
+}
+#[allow(unused)]
+impl Hostname {
+       pub(crate) fn get_native_ref(&self) -> &'static nativeHostname {
+               unsafe { &*ObjOps::untweak_ptr(self.inner) }
+       }
+       pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeHostname {
+               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 nativeHostname {
+               assert!(self.is_owned);
+               let ret = ObjOps::untweak_ptr(self.inner);
+               self.inner = core::ptr::null_mut();
+               ret
+       }
+}
+impl Clone for Hostname {
+       fn clone(&self) -> Self {
+               Self {
+                       inner: if <*mut nativeHostname>::is_null(self.inner) { core::ptr::null_mut() } else {
+                               ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
+                       is_owned: true,
+               }
+       }
+}
+#[allow(unused)]
+/// Used only if an object of this type is returned as a trait impl by a method
+pub(crate) extern "C" fn Hostname_clone_void(this_ptr: *const c_void) -> *mut c_void {
+       Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeHostname)).clone() })) as *mut c_void
+}
+#[no_mangle]
+/// Creates a copy of the Hostname
+pub extern "C" fn Hostname_clone(orig: &Hostname) -> Hostname {
+       orig.clone()
+}
+/// Checks if two Hostnames contain equal inner contents.
+/// This ignores pointers and is_owned flags and looks at the values in fields.
+/// Two objects with NULL inner values will be considered "equal" here.
+#[no_mangle]
+pub extern "C" fn Hostname_eq(a: &Hostname, b: &Hostname) -> bool {
+       if a.inner == b.inner { return true; }
+       if a.inner.is_null() || b.inner.is_null() { return false; }
+       if a.get_native_ref() == b.get_native_ref() { true } else { false }
+}
+/// Returns the length of the hostname.
+#[must_use]
+#[no_mangle]
+pub extern "C" fn Hostname_len(this_arg: &crate::lightning::util::ser::Hostname) -> u8 {
+       let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.len();
+       ret
+}
+