Skip to main content

Payment

Struct Payment 

Source
pub struct Payment<S> { /* private fields */ }
Expand description

A payment moving through the verify → settle lifecycle.

The type parameter S tracks the current state at compile time. The struct is transparent (zero overhead) around the underlying request.

Implementations§

Source§

impl<S> Payment<S>

Source

pub const fn request(&self) -> &VerifyRequest

Returns a reference to the wire-level verify request this payment was constructed from.

Source§

impl Payment<Unverified>

Source

pub const fn new(request: VerifyRequest) -> Self

Wraps a raw verify request as an unverified payment.

Source

pub async fn verify<F: Facilitator>( self, facilitator: &F, request: VerifyRequest, ) -> Result<(Payment<Verified>, VerifyResponse), FacilitatorError>

Runs facilitator verification.

On success, returns the verified payment together with the facilitator’s VerifyResponse. On failure, the payment is consumed and a FacilitatorError is returned.

§Errors

Propagates any FacilitatorError raised by the underlying facilitator. A Valid verification that returns VerifyResponse::Invalid is surfaced as Err(FacilitatorError::Verification(VerificationError::InvalidFormat)).

Source§

impl Payment<Verified>

Source

pub async fn settle<F: Facilitator>( self, facilitator: &F, request: SettleRequest, ) -> Result<(Payment<Settled>, SettleResponse), FacilitatorError>

Runs facilitator settlement on a previously verified payment.

§Errors

Propagates any FacilitatorError raised by the facilitator; a SettleResponse::Failure is surfaced as Err(FacilitatorError::Onchain(...)).

Source§

impl Payment<Settled>

Source

pub fn into_request(self) -> VerifyRequest

Extracts the underlying wire-level request.

Trait Implementations§

Source§

impl<S: Clone> Clone for Payment<S>

Source§

fn clone(&self) -> Payment<S>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S: Debug> Debug for Payment<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> Freeze for Payment<S>

§

impl<S> RefUnwindSafe for Payment<S>

§

impl<S> Send for Payment<S>

§

impl<S> Sync for Payment<S>

§

impl<S> Unpin for Payment<S>

§

impl<S> UnsafeUnpin for Payment<S>

§

impl<S> UnwindSafe for Payment<S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more