Update auto-generated bindings to 0.0.103
[ldk-java] / src / main / java / org / ldk / structs / ErrorMessage.java
index d0182f319b3e18ef8248c7549c7c47277a35ed7b..1fcb6d257f0d81b276e75f431f8381acd6c5fb2b 100644 (file)
@@ -4,56 +4,94 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import javax.annotation.Nullable;
 
+
+/**
+ * An error message to be sent or received from a peer
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ErrorMessage extends CommonBase {
        ErrorMessage(Object _dummy, long ptr) { super(ptr); }
        @Override @SuppressWarnings("deprecation")
        protected void finalize() throws Throwable {
                super.finalize();
-               bindings.ErrorMessage_free(ptr);
-       }
-
-       public static ErrorMessage constructor_clone(ErrorMessage orig) {
-               long ret = bindings.ErrorMessage_clone(orig == null ? 0 : orig.ptr & ~1);
-               ErrorMessage ret_hu_conv = new ErrorMessage(null, ret);
-               ret_hu_conv.ptrs_to.add(orig);
-               return ret_hu_conv;
+               if (ptr != 0) { bindings.ErrorMessage_free(ptr); }
        }
 
+       /**
+        * The channel ID involved in the error
+        */
        public byte[] get_channel_id() {
                byte[] ret = bindings.ErrorMessage_get_channel_id(this.ptr);
                return ret;
        }
 
+       /**
+        * The channel ID involved in the error
+        */
        public void set_channel_id(byte[] val) {
                bindings.ErrorMessage_set_channel_id(this.ptr, val);
        }
 
+       /**
+        * A possibly human-readable error description.
+        * The string should be sanitized before it is used (e.g. emitted to logs
+        * or printed to stdout).  Otherwise, a well crafted error message may trigger a security
+        * vulnerability in the terminal emulator or the logging subsystem.
+        */
        public String get_data() {
                String ret = bindings.ErrorMessage_get_data(this.ptr);
                return ret;
        }
 
-       public void set_data(byte[] val) {
+       /**
+        * A possibly human-readable error description.
+        * The string should be sanitized before it is used (e.g. emitted to logs
+        * or printed to stdout).  Otherwise, a well crafted error message may trigger a security
+        * vulnerability in the terminal emulator or the logging subsystem.
+        */
+       public void set_data(java.lang.String val) {
                bindings.ErrorMessage_set_data(this.ptr, val);
        }
 
-       public static ErrorMessage constructor_new(byte[] channel_id_arg, byte[] data_arg) {
+       /**
+        * Constructs a new ErrorMessage given each field
+        */
+       public static ErrorMessage of(byte[] channel_id_arg, java.lang.String data_arg) {
                long ret = bindings.ErrorMessage_new(channel_id_arg, data_arg);
-               ErrorMessage ret_hu_conv = new ErrorMessage(null, ret);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               ErrorMessage ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ErrorMessage(null, ret); }
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Creates a copy of the ErrorMessage
+        */
+       public ErrorMessage clone() {
+               long ret = bindings.ErrorMessage_clone(this.ptr);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               ErrorMessage ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ErrorMessage(null, ret); }
+               ret_hu_conv.ptrs_to.add(this);
                return ret_hu_conv;
        }
 
-       public byte[] write(ErrorMessage obj) {
-               byte[] ret = bindings.ErrorMessage_write(obj == null ? 0 : obj.ptr & ~1);
-               this.ptrs_to.add(obj);
+       /**
+        * Serialize the ErrorMessage object into a byte array which can be read by ErrorMessage_read
+        */
+       public byte[] write() {
+               byte[] ret = bindings.ErrorMessage_write(this.ptr);
                return ret;
        }
 
-       public static ErrorMessage constructor_read(byte[] ser) {
+       /**
+        * Read a ErrorMessage from a byte array, created by ErrorMessage_write
+        */
+       public static Result_ErrorMessageDecodeErrorZ read(byte[] ser) {
                long ret = bindings.ErrorMessage_read(ser);
-               ErrorMessage ret_hu_conv = new ErrorMessage(null, ret);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_ErrorMessageDecodeErrorZ ret_hu_conv = Result_ErrorMessageDecodeErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }