Skip to main content

Payload

Enum Payload 

Source
pub enum Payload {
Show 13 variants Order(SmallOrder), PaymentRequest(Option<SmallOrder>, String, Option<i64>), TextMessage(String), Peer(Peer), RatingUser(u8), Amount(i64), Dispute(Uuid, Option<SolverDisputeInfo>), CantDo(Option<CantDoReason>), NextTrade(String, u32), PaymentFailed(PaymentFailedInfo), RestoreData(RestoreSessionInfo), Ids(Vec<Uuid>), Orders(Vec<SmallOrder>),
}
Expand description

Typed payload attached to a MessageKind.

Each variant corresponds to a set of Action values that can legally carry it (see MessageKind::verify). Serialized in snake_case so that the variant name is the JSON discriminator.

Variants§

§

Order(SmallOrder)

A compact representation of an order used by Action::NewOrder.

§

PaymentRequest(Option<SmallOrder>, String, Option<i64>)

Lightning payment request plus optional amount override.

Used by Action::PayInvoice, Action::AddInvoice and Action::TakeSell. The SmallOrder carries the matching order when relevant; the String is a BOLT-11 invoice.

§

TextMessage(String)

Free-form text message used by DMs.

§

Peer(Peer)

Peer disclosure (trade pubkey and optional reputation).

§

RatingUser(u8)

Rating value the user wants to attach to a completed trade.

§

Amount(i64)

Raw amount in satoshis (for actions that accept an amount override).

§

Dispute(Uuid, Option<SolverDisputeInfo>)

Dispute context: the dispute id plus optional SolverDisputeInfo bundle sent to solvers.

§

CantDo(Option<CantDoReason>)

Reason carried by a Action::CantDo response.

§

NextTrade(String, u32)

Next trade key and index announced by the maker of a range order when it emits Action::Release or Action::FiatSent.

§

PaymentFailed(PaymentFailedInfo)

Retry configuration surfaced by Action::PaymentFailed.

§

RestoreData(RestoreSessionInfo)

Payload returned by the server on a session restore.

§

Ids(Vec<Uuid>)

Vector of order ids (lightweight listing).

§

Orders(Vec<SmallOrder>)

Vector of SmallOrder values (full listing).

Trait Implementations§

Source§

impl Clone for Payload

Source§

fn clone(&self) -> Payload

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Payload

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Payload

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Payload

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,