Struct WaitForNextPaymentRequest

pub struct WaitForNextPaymentRequest {
    pub start_index: Option<PaymentUpdatedIndex>,
    pub timeout: Option<Duration>,
}

A request to wait for the payment information of the next updated payment.

Fields

start_index: Option<PaymentUpdatedIndex>

The start index to begin waiting from. When tailing updates, this acts as a cursor, and callers should set start_index using the previous WaitForNextPaymentResponse::next_start_index.

If Some: The next payment will have updated_at > start_index, and there will not exist any other payments with an updated_at in between.

If None, and:

• Persistence is enabled: The next payment with an update that hasn’t been recorded locally will be returned.
• Persistence is disabled: The next payment update received by the node will be returned.

timeout: Option<Duration>

If given, this method will stop waiting after timeout duration has passed and return an error. If None, this method will wait indefinitely.

Trait Implementations

impl<'de> Deserialize<'de> for WaitForNextPaymentRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WaitForNextPaymentRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.