Struct bee_message::payload::receipt::ReceiptPayload

pub struct ReceiptPayload { /* fields omitted */ }

Receipt is a listing of migrated funds.

Implementations

impl ReceiptPayload

pub const KIND: u32

The payload kind of a ReceiptPayload.

pub fn new(
    migrated_at: MilestoneIndex,
    last: bool,
    funds: Vec<MigratedFundsEntry>,
    transaction: Payload
) -> Result<Self, Error>

Creates a new ReceiptPayload.

pub fn migrated_at(&self) -> MilestoneIndex

Returns the milestone index at which the funds of a ReceiptPayload were migrated at in the legacy network.

pub fn last(&self) -> bool

Returns whether a ReceiptPayload is the final one for a given migrated at index.

pub fn funds(&self) -> &[MigratedFundsEntry]

The funds which were migrated with a ReceiptPayload.

pub fn transaction(&self) -> &Payload

The TreasuryTransaction used to fund the funds of a ReceiptPayload.

pub fn amount(&self) -> u64

Returns the sum of all MigratedFundsEntry items within a ReceiptPayload.

Trait Implementations

impl Clone for ReceiptPayload

fn clone(&self) -> ReceiptPayload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiptPayload

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

Formats the value using the given formatter.

impl Eq for ReceiptPayload

impl From<ReceiptPayload> for Payload

fn from(payload: ReceiptPayload) -> Self

Performs the conversion.

impl Packable for ReceiptPayload

type Error = Error

Associated error type.

fn packed_len(&self) -> usize

Returns the length of the packed bytes.

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

Packs the instance to bytes and writes them to the passed writer.

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error>

Reads bytes from the passed reader and unpacks them into an instance.

pub fn pack_new(&self) -> Vec<u8, Global>

Packs the instance to bytes and writes them to a newly allocated vector.

pub fn unpack<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read + ?Sized, 

Reads bytes from the passed reader and unpacks them into an instance. Applies syntactic checks.

pub fn unpack_unchecked<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read + ?Sized, 

Reads bytes from the passed reader and unpacks them into an instance. Doesn’t apply syntactic checks.

impl PartialEq<ReceiptPayload> for ReceiptPayload

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

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

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

This method tests for !=.

impl StructuralEq for ReceiptPayload

impl StructuralPartialEq for ReceiptPayload