Struct bee_message::payload::indexation::IndexationPayload

pub struct IndexationPayload { /* fields omitted */ }

A payload which holds an index and associated data.

Implementations

impl IndexationPayload

pub const KIND: u32

The payload kind of an IndexationPayload.

pub fn new(index: &[u8], data: &[u8]) -> Result<Self, Error>

Creates a new IndexationPayload.

pub fn index(&self) -> &[u8]

Returns the index of an IndexationPayload.

pub fn padded_index(&self) -> PaddedIndex

Returns the padded index of an IndexationPayload.

pub fn data(&self) -> &[u8]

Returns the data of an IndexationPayload.

Trait Implementations

impl Clone for IndexationPayload

fn clone(&self) -> IndexationPayload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexationPayload

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

Formats the value using the given formatter.

impl Eq for IndexationPayload

impl From<IndexationPayload> for Payload

fn from(payload: IndexationPayload) -> Self

Performs the conversion.

impl Packable for IndexationPayload

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

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

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

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

This method tests for !=.

impl StructuralEq for IndexationPayload

impl StructuralPartialEq for IndexationPayload