Struct ReceiptsMessageOutSubject

pub struct ReceiptsMessageOutSubject {
    pub tx_id: Option<Bytes32>,
    pub index: Option<usize>,
    pub sender: Option<Address>,
    pub recipient: Option<Address>,
}

Represents a subject for message-out receipts in the Fuel network.

This subject format allows for efficient querying and filtering of message-out receipts based on the transaction ID (tx_id), index (index), sender address (sender), and recipient address (recipient).

Examples

Creating a subject for a specific message-out receipt:

let subject = ReceiptsMessageOutSubject {
    tx_id: Some(Bytes32::from([1u8; 32])),
    index: Some(0),
    sender: Some(Address::from([2u8; 32])),
    recipient: Some(Address::from([3u8; 32])),
};
assert_eq!(
    subject.parse(),
    "receipts.0x0101010101010101010101010101010101010101010101010101010101010101.0.message_out.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303"
);

Wildcard for querying all message-out receipts:

assert_eq!(ReceiptsMessageOutSubject::WILDCARD, "receipts.>");

Creating a subject query using the wildcard method:

let wildcard = ReceiptsMessageOutSubject::wildcard(
    Some(Bytes32::from([1u8; 32])),
    None,
    Some(Address::from([2u8; 32])),
    Some(Address::from([3u8; 32])),
);
assert_eq!(
    wildcard,
    "receipts.0x0101010101010101010101010101010101010101010101010101010101010101.*.message_out.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303"
);

Using the builder pattern:

let subject = ReceiptsMessageOutSubject::new()
    .with_tx_id(Some(Bytes32::from([1u8; 32])))
    .with_index(Some(0))
    .with_sender(Some(Address::from([2u8; 32])))
    .with_recipient(Some(Address::from([3u8; 32])));
assert_eq!(
    subject.parse(),
    "receipts.0x0101010101010101010101010101010101010101010101010101010101010101.0.message_out.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303"
);

Fields

tx_id: Option<Bytes32>

index: Option<usize>

sender: Option<Address>

recipient: Option<Address>

Implementations

impl ReceiptsMessageOutSubject

pub const WILDCARD: &'static str = "receipts.>"

pub fn build( tx_id: Option<Bytes32>, index: Option<usize>, sender: Option<Address>, recipient: Option<Address>, ) -> Self

pub fn wildcard( tx_id: Option<Bytes32>, index: Option<usize>, sender: Option<Address>, recipient: Option<Address>, ) -> String

pub fn boxed(self) -> Box<Self>

pub fn arc(self) -> Arc<Self>

pub fn with_tx_id(self, value: Option<Bytes32>) -> Self

pub fn with_index(self, value: Option<usize>) -> Self

pub fn with_sender(self, value: Option<Address>) -> Self

pub fn with_recipient(self, value: Option<Address>) -> Self

Trait Implementations

impl Clone for ReceiptsMessageOutSubject

fn clone(&self) -> ReceiptsMessageOutSubject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiptsMessageOutSubject

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

Formats the value using the given formatter.

impl Default for ReceiptsMessageOutSubject

fn default() -> ReceiptsMessageOutSubject

Returns the “default value” for a type.

impl Display for ReceiptsMessageOutSubject

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

Formats the value using the given formatter.

impl IntoSubject for ReceiptsMessageOutSubject

fn parse(&self) -> String

fn wildcard(&self) -> &'static str

impl SubjectBuildable for ReceiptsMessageOutSubject

fn new() -> Self