Enum bee_message::payload::Payload

#[non_exhaustive]
pub enum Payload {
    Transaction(Box<TransactionPayload>),
    Milestone(Box<MilestonePayload>),
    Indexation(Box<IndexationPayload>),
    Receipt(Box<ReceiptPayload>),
    TreasuryTransaction(Box<TreasuryTransactionPayload>),
}

A generic payload that can represent different types defining message payloads.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Transaction(Box<TransactionPayload>)

A transaction payload.

Milestone(Box<MilestonePayload>)

A milestone payload.

Indexation(Box<IndexationPayload>)

An indexation payload.

Receipt(Box<ReceiptPayload>)

A receipt payload.

TreasuryTransaction(Box<TreasuryTransactionPayload>)

A treasury transaction payload.

Implementations

impl Payload

pub fn kind(&self) -> u32

Returns the payload kind of a Payload.

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl Eq for Payload

impl From<IndexationPayload> for Payload

fn from(payload: IndexationPayload) -> Self

Performs the conversion.

impl From<MilestonePayload> for Payload

fn from(payload: MilestonePayload) -> Self

Performs the conversion.

impl From<ReceiptPayload> for Payload

fn from(payload: ReceiptPayload) -> Self

Performs the conversion.

impl From<TransactionPayload> for Payload

fn from(payload: TransactionPayload) -> Self

Performs the conversion.

impl From<TreasuryTransactionPayload> for Payload

fn from(payload: TreasuryTransactionPayload) -> Self

Performs the conversion.

impl Packable for Payload

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<Payload> for Payload

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

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

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

This method tests for !=.

impl StructuralEq for Payload

impl StructuralPartialEq for Payload