1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
4 // This file is licensed under the license available in the LICENSE or LICENSE.md
5 // file in the root of this repository or, if no such file exists, the same
6 // license as that which applies to the original source files from which this
7 // source was automatically generated.
9 //! Message handling for BOLT 12 Offers.
11 use alloc::str::FromStr;
12 use alloc::string::String;
13 use core::ffi::c_void;
14 use core::convert::Infallible;
15 use bitcoin::hashes::Hash;
16 use crate::c_types::*;
17 #[cfg(feature="no-std")]
18 use alloc::{vec::Vec, boxed::Box};
20 /// A handler for an [`OnionMessage`] containing a BOLT 12 Offers message as its payload.
22 /// [`OnionMessage`]: crate::ln::msgs::OnionMessage
24 pub struct OffersMessageHandler {
25 /// An opaque pointer which is passed to your function implementations as an argument.
26 /// This has no meaning in the LDK, and can be NULL or any other value.
27 pub this_arg: *mut c_void,
28 /// Handles the given message by either responding with an [`Bolt12Invoice`], sending a payment,
29 /// or replying with an error.
30 pub handle_message: extern "C" fn (this_arg: *const c_void, message: crate::lightning::onion_message::offers::OffersMessage) -> crate::c_types::derived::COption_OffersMessageZ,
31 /// Frees any resources associated with this object given its this_arg pointer.
32 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
33 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
35 unsafe impl Send for OffersMessageHandler {}
36 unsafe impl Sync for OffersMessageHandler {}
37 pub(crate) fn OffersMessageHandler_clone_fields(orig: &OffersMessageHandler) -> OffersMessageHandler {
38 OffersMessageHandler {
39 this_arg: orig.this_arg,
40 handle_message: Clone::clone(&orig.handle_message),
41 free: Clone::clone(&orig.free),
45 use lightning::onion_message::offers::OffersMessageHandler as rustOffersMessageHandler;
46 impl rustOffersMessageHandler for OffersMessageHandler {
47 fn handle_message(&self, mut message: lightning::onion_message::offers::OffersMessage) -> Option<lightning::onion_message::offers::OffersMessage> {
48 let mut ret = (self.handle_message)(self.this_arg, crate::lightning::onion_message::offers::OffersMessage::native_into(message));
49 let mut local_ret = { /*ret*/ let ret_opt = ret; if ret_opt.is_none() { None } else { Some({ { { ret_opt.take() }.into_native() }})} };
54 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
55 // directly as a Deref trait in higher-level structs:
56 impl core::ops::Deref for OffersMessageHandler {
58 fn deref(&self) -> &Self {
62 impl core::ops::DerefMut for OffersMessageHandler {
63 fn deref_mut(&mut self) -> &mut Self {
67 /// Calls the free function if one is set
69 pub extern "C" fn OffersMessageHandler_free(this_ptr: OffersMessageHandler) { }
70 impl Drop for OffersMessageHandler {
72 if let Some(f) = self.free {
77 /// Possible BOLT 12 Offers messages sent and received via an [`OnionMessage`].
79 /// [`OnionMessage`]: crate::ln::msgs::OnionMessage
83 pub enum OffersMessage {
84 /// A request for a [`Bolt12Invoice`] for a particular [`Offer`].
86 /// [`Offer`]: crate::offers::offer::Offer
88 crate::lightning::offers::invoice_request::InvoiceRequest),
89 /// A [`Bolt12Invoice`] sent in response to an [`InvoiceRequest`] or a [`Refund`].
91 /// [`Refund`]: crate::offers::refund::Refund
93 crate::lightning::offers::invoice::Bolt12Invoice),
94 /// An error from handling an [`OffersMessage`].
96 crate::lightning::offers::invoice_error::InvoiceError),
98 use lightning::onion_message::offers::OffersMessage as OffersMessageImport;
99 pub(crate) type nativeOffersMessage = OffersMessageImport;
103 pub(crate) fn to_native(&self) -> nativeOffersMessage {
105 OffersMessage::InvoiceRequest (ref a, ) => {
106 let mut a_nonref = Clone::clone(a);
107 nativeOffersMessage::InvoiceRequest (
108 *unsafe { Box::from_raw(a_nonref.take_inner()) },
111 OffersMessage::Invoice (ref a, ) => {
112 let mut a_nonref = Clone::clone(a);
113 nativeOffersMessage::Invoice (
114 *unsafe { Box::from_raw(a_nonref.take_inner()) },
117 OffersMessage::InvoiceError (ref a, ) => {
118 let mut a_nonref = Clone::clone(a);
119 nativeOffersMessage::InvoiceError (
120 *unsafe { Box::from_raw(a_nonref.take_inner()) },
126 pub(crate) fn into_native(self) -> nativeOffersMessage {
128 OffersMessage::InvoiceRequest (mut a, ) => {
129 nativeOffersMessage::InvoiceRequest (
130 *unsafe { Box::from_raw(a.take_inner()) },
133 OffersMessage::Invoice (mut a, ) => {
134 nativeOffersMessage::Invoice (
135 *unsafe { Box::from_raw(a.take_inner()) },
138 OffersMessage::InvoiceError (mut a, ) => {
139 nativeOffersMessage::InvoiceError (
140 *unsafe { Box::from_raw(a.take_inner()) },
146 pub(crate) fn from_native(native: &nativeOffersMessage) -> Self {
148 nativeOffersMessage::InvoiceRequest (ref a, ) => {
149 let mut a_nonref = Clone::clone(a);
150 OffersMessage::InvoiceRequest (
151 crate::lightning::offers::invoice_request::InvoiceRequest { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
154 nativeOffersMessage::Invoice (ref a, ) => {
155 let mut a_nonref = Clone::clone(a);
156 OffersMessage::Invoice (
157 crate::lightning::offers::invoice::Bolt12Invoice { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
160 nativeOffersMessage::InvoiceError (ref a, ) => {
161 let mut a_nonref = Clone::clone(a);
162 OffersMessage::InvoiceError (
163 crate::lightning::offers::invoice_error::InvoiceError { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
169 pub(crate) fn native_into(native: nativeOffersMessage) -> Self {
171 nativeOffersMessage::InvoiceRequest (mut a, ) => {
172 OffersMessage::InvoiceRequest (
173 crate::lightning::offers::invoice_request::InvoiceRequest { inner: ObjOps::heap_alloc(a), is_owned: true },
176 nativeOffersMessage::Invoice (mut a, ) => {
177 OffersMessage::Invoice (
178 crate::lightning::offers::invoice::Bolt12Invoice { inner: ObjOps::heap_alloc(a), is_owned: true },
181 nativeOffersMessage::InvoiceError (mut a, ) => {
182 OffersMessage::InvoiceError (
183 crate::lightning::offers::invoice_error::InvoiceError { inner: ObjOps::heap_alloc(a), is_owned: true },
189 /// Frees any resources used by the OffersMessage
191 pub extern "C" fn OffersMessage_free(this_ptr: OffersMessage) { }
192 /// Creates a copy of the OffersMessage
194 pub extern "C" fn OffersMessage_clone(orig: &OffersMessage) -> OffersMessage {
198 /// Utility method to constructs a new InvoiceRequest-variant OffersMessage
199 pub extern "C" fn OffersMessage_invoice_request(a: crate::lightning::offers::invoice_request::InvoiceRequest) -> OffersMessage {
200 OffersMessage::InvoiceRequest(a, )
203 /// Utility method to constructs a new Invoice-variant OffersMessage
204 pub extern "C" fn OffersMessage_invoice(a: crate::lightning::offers::invoice::Bolt12Invoice) -> OffersMessage {
205 OffersMessage::Invoice(a, )
208 /// Utility method to constructs a new InvoiceError-variant OffersMessage
209 pub extern "C" fn OffersMessage_invoice_error(a: crate::lightning::offers::invoice_error::InvoiceError) -> OffersMessage {
210 OffersMessage::InvoiceError(a, )
212 /// Returns whether `tlv_type` corresponds to a TLV record for Offers.
215 pub extern "C" fn OffersMessage_is_known_type(mut tlv_type: u64) -> bool {
216 let mut ret = lightning::onion_message::offers::OffersMessage::is_known_type(tlv_type);
220 /// The TLV record type for the message as used in an `onionmsg_tlv` TLV stream.
223 pub extern "C" fn OffersMessage_tlv_type(this_arg: &crate::lightning::onion_message::offers::OffersMessage) -> u64 {
224 let mut ret = this_arg.to_native().tlv_type();
229 /// Serialize the OffersMessage object into a byte array which can be read by OffersMessage_read
230 pub extern "C" fn OffersMessage_write(obj: &crate::lightning::onion_message::offers::OffersMessage) -> crate::c_types::derived::CVec_u8Z {
231 crate::c_types::serialize_obj(&unsafe { &*obj }.to_native())
234 /// Read a OffersMessage from a byte array, created by OffersMessage_write
235 pub extern "C" fn OffersMessage_read(ser: crate::c_types::u8slice, arg_a: u64, arg_b: &crate::lightning::util::logger::Logger) -> crate::c_types::derived::CResult_OffersMessageDecodeErrorZ {
236 let arg_a_conv = arg_a;
237 let arg_b_conv = arg_b;
238 let arg_conv = (arg_a_conv, arg_b_conv);
239 let res: Result<lightning::onion_message::offers::OffersMessage, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv);
240 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::onion_message::offers::OffersMessage::native_into(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };