Struct lnd_grpc_rust::routerrpc::ForwardHtlcInterceptResponse

pub struct ForwardHtlcInterceptResponse {
    pub incoming_circuit_key: Option<CircuitKey>,
    pub action: i32,
    pub preimage: Vec<u8>,
    pub failure_message: Vec<u8>,
    pub failure_code: i32,
}

ForwardHtlcInterceptResponse enables the caller to resolve a previously hold forward. The caller can choose either to:

• Resume: Execute the default behavior (usually forward).
• Reject: Fail the htlc backwards.
• Settle: Settle this htlc with a given preimage.

Fields

incoming_circuit_key: Option<CircuitKey>

The key of this forwarded htlc. It defines the incoming channel id and the index in this channel.

action: i32

The resolve action for this intercepted htlc.

preimage: Vec<u8>

The preimage in case the resolve action is Settle.

failure_message: Vec<u8>

Encrypted failure message in case the resolve action is Fail.

If failure_message is specified, the failure_code field must be set to zero.

failure_code: i32

Return the specified failure code in case the resolve action is Fail. The message data fields are populated automatically.

If a non-zero failure_code is specified, failure_message must not be set.

For backwards-compatibility reasons, TEMPORARY_CHANNEL_FAILURE is the default value for this field.

Implementations

impl ForwardHtlcInterceptResponse

pub fn action(&self) -> ResolveHoldForwardAction

Returns the enum value of action, or the default if the field is set to an invalid enum value.

pub fn set_action(&mut self, value: ResolveHoldForwardAction)

Sets action to the provided enum value.

pub fn failure_code(&self) -> FailureCode

Returns the enum value of failure_code, or the default if the field is set to an invalid enum value.

pub fn set_failure_code(&mut self, value: FailureCode)

Sets failure_code to the provided enum value.

Trait Implementations

impl Clone for ForwardHtlcInterceptResponse

fn clone(&self) -> ForwardHtlcInterceptResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ForwardHtlcInterceptResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ForwardHtlcInterceptResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for ForwardHtlcInterceptResponse

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ForwardHtlcInterceptResponse

fn eq(&self, other: &ForwardHtlcInterceptResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ForwardHtlcInterceptResponse