Package org.ldk.structs

Class InvoiceError

java.lang.Object

org.ldk.structs.InvoiceError

public class InvoiceError
extends Object

An error in response to an [`InvoiceRequest`] or an [`Bolt12Invoice`]. [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice

Method Summary

Modifier and Type	Method	Description
InvoiceError	clone()	Creates a copy of the InvoiceError
protected void	finalize()
ErroneousField	get_erroneous_field()	The field in the [`InvoiceRequest`] or the [`Bolt12Invoice`] that contained an error.
UntrustedString	get_message()	An explanation of the error.
static InvoiceError	of(ErroneousField erroneous_field_arg, UntrustedString message_arg)	Constructs a new InvoiceError given each field Note that erroneous_field_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
static Result_InvoiceErrorDecodeErrorZ	read(byte[] ser)	Read a InvoiceError from a byte array, created by InvoiceError_write
void	set_erroneous_field(ErroneousField val)	The field in the [`InvoiceRequest`] or the [`Bolt12Invoice`] that contained an error.
void	set_message(UntrustedString val)	An explanation of the error.
byte[]	write()	Serialize the InvoiceError object into a byte array which can be read by InvoiceError_read

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

get_erroneous_field

@Nullable
public ErroneousField get_erroneous_field()

The field in the [`InvoiceRequest`] or the [`Bolt12Invoice`] that contained an error. [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None

set_erroneous_field

public void set_erroneous_field(@Nullable
                                ErroneousField val)

The field in the [`InvoiceRequest`] or the [`Bolt12Invoice`] that contained an error. [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None

get_message

public UntrustedString get_message()

An explanation of the error.

set_message

public void set_message(UntrustedString val)

An explanation of the error.

of

public static InvoiceError of(@Nullable
                              ErroneousField erroneous_field_arg,
                              UntrustedString message_arg)

Constructs a new InvoiceError given each field Note that erroneous_field_arg (or a relevant inner pointer) may be NULL or all-0s to represent None

clone

public InvoiceError clone()

Creates a copy of the InvoiceError

Overrides:

clone in class Object

write

public byte[] write()

Serialize the InvoiceError object into a byte array which can be read by InvoiceError_read

read

public static Result_InvoiceErrorDecodeErrorZ read(byte[] ser)

Read a InvoiceError from a byte array, created by InvoiceError_write