Struct fuel_tx::input::message::Message

pub struct Message<Specification>where
    Specification: MessageSpecification,{
    pub sender: Address,
    pub recipient: Address,
    pub amount: Word,
    pub nonce: Nonce,
    pub witness_index: Specification::Witness,
    pub data: Specification::Data,
    pub predicate: Specification::Predicate,
    pub predicate_data: Specification::PredicateData,
}

It is a full representation of the message from the specification: https://github.com/FuelLabs/fuel-specs/blob/master/src/protocol/tx_format/input.md#inputmessage.

The specification defines the layout of the Message in the serialized form for the fuel-vm. But on the business logic level, we don’t use all fields at the same time. It is why in the super::Input the message is represented by several forms based on the usage context. Leaving some fields empty reduces the memory consumption by the structure and erases the empty useless fields.

The MessageSpecification trait specifies the sub-messages for the corresponding usage context. It allows us to write the common logic of all sub-messages without the overhead and duplication.

Sub-messages from specifications:

• specifications::MessageData with specifications::Signed usage rules.
• specifications::MessageData with specifications::Predicate usage rules.
• specifications::Full.

Fields

sender: Address

The sender from the L1 chain.

recipient: Address

The receiver on the Fuel chain.

amount: Word

nonce: Nonce

witness_index: Specification::Witness

data: Specification::Data

predicate: Specification::Predicate

predicate_data: Specification::PredicateData

Implementations

impl<Specification> Message<Specification>where Specification: MessageSpecification,

pub fn prepare_sign(&mut self)

It is empty, because specification says nothing: https://github.com/FuelLabs/fuel-specs/blob/master/src/protocol/tx_format/input.md#inputmessage

pub fn message_id(&self) -> MessageId

impl Message<Full>

pub fn into_message_data_signed(self) -> MessageDataSigned

pub fn into_message_data_predicate(self) -> MessageDataPredicate

pub fn into_coin_signed(self) -> MessageCoinSigned

pub fn into_coin_predicate(self) -> MessageCoinPredicate

Trait Implementations

impl<Specification> Clone for Message<Specification>where Specification: MessageSpecification + Clone, Specification::Witness: Clone, Specification::Data: Clone, Specification::Predicate: Clone, Specification::PredicateData: Clone,

fn clone(&self) -> Message<Specification>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Specification> Debug for Message<Specification>where Specification: MessageSpecification,

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

Formats the value using the given formatter.

impl<Specification> Default for Message<Specification>where Specification: MessageSpecification + Default, Specification::Witness: Default, Specification::Data: Default, Specification::Predicate: Default, Specification::PredicateData: Default,

fn default() -> Message<Specification>

Returns the “default value” for a type.

impl<Specification> Hash for Message<Specification>where Specification: MessageSpecification + Hash, Specification::Witness: Hash, Specification::Data: Hash, Specification::Predicate: Hash, Specification::PredicateData: Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Specification> PartialEq<Message<Specification>> for Message<Specification>where Specification: MessageSpecification + PartialEq, Specification::Witness: PartialEq, Specification::Data: PartialEq, Specification::Predicate: PartialEq, Specification::PredicateData: PartialEq,

fn eq(&self, other: &Message<Specification>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Specification> Read for Message<Specification>where Specification: MessageSpecification,

fn read(&mut self, full_buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<Specification> SizedBytes for Message<Specification>where Specification: MessageSpecification,

fn serialized_size(&self) -> usize

Return the expected serialized size for an instance of the type.

impl<Specification> Write for Message<Specification>where Specification: MessageSpecification,

fn write(&mut self, full_buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<Specification> Eq for Message<Specification>where Specification: MessageSpecification + Eq, Specification::Witness: Eq, Specification::Data: Eq, Specification::Predicate: Eq, Specification::PredicateData: Eq,

impl<Specification> StructuralEq for Message<Specification>where Specification: MessageSpecification,

impl<Specification> StructuralPartialEq for Message<Specification>where Specification: MessageSpecification,