Struct ReceiptsTransferOutSubject

pub struct ReceiptsTransferOutSubject {
    pub tx_id: Option<Bytes32>,
    pub index: Option<usize>,
    pub from: Option<ContractId>,
    pub to: Option<Address>,
    pub asset_id: Option<AssetId>,
}

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

This subject format allows for efficient querying and filtering of transfer-out receipts based on the transaction ID, index, the contract ID of the sender (from), the address of the receiver (to), and the asset ID involved in the transfer-out.

Examples

Creating a subject for a specific transfer-out receipt:

let subject = ReceiptsTransferOutSubject {
    tx_id: Some(Bytes32::from([1u8; 32])),
    index: Some(0),
    from: Some(ContractId::from([2u8; 32])),
    to: Some(Address::from([3u8; 32])),
    asset_id: Some(AssetId::from([4u8; 32])),
};
assert_eq!(
    subject.parse(),
    "receipts.0x0101010101010101010101010101010101010101010101010101010101010101.0.transfer_out.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303.0x0404040404040404040404040404040404040404040404040404040404040404"
);

Wildcard for querying all transfer-out receipts:

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

Creating a subject query using the wildcard method:

let wildcard = ReceiptsTransferOutSubject::wildcard(
    Some(Bytes32::from([1u8; 32])),
    None,
    Some(ContractId::from([2u8; 32])),
    Some(Address::from([3u8; 32])),
    Some(AssetId::from([4u8; 32]))
);
assert_eq!(
    wildcard,
    "receipts.0x0101010101010101010101010101010101010101010101010101010101010101.*.transfer_out.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303.0x0404040404040404040404040404040404040404040404040404040404040404"
);

Using the builder pattern:

let subject = ReceiptsTransferOutSubject::new()
    .with_tx_id(Some(Bytes32::from([1u8; 32])))
    .with_index(Some(0))
    .with_from(Some(ContractId::from([2u8; 32])))
    .with_to(Some(Address::from([3u8; 32])))
    .with_asset_id(Some(AssetId::from([4u8; 32])));
assert_eq!(
    subject.parse(),
    "receipts.0x0101010101010101010101010101010101010101010101010101010101010101.0.transfer_out.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303.0x0404040404040404040404040404040404040404040404040404040404040404"
);

Fields

tx_id: Option<Bytes32>

index: Option<usize>

from: Option<ContractId>

to: Option<Address>

asset_id: Option<AssetId>

Implementations

impl ReceiptsTransferOutSubject

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

pub fn build( tx_id: Option<Bytes32>, index: Option<usize>, from: Option<ContractId>, to: Option<Address>, asset_id: Option<AssetId>, ) -> Self

pub fn wildcard( tx_id: Option<Bytes32>, index: Option<usize>, from: Option<ContractId>, to: Option<Address>, asset_id: Option<AssetId>, ) -> 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_from(self, value: Option<ContractId>) -> Self

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

pub fn with_asset_id(self, value: Option<AssetId>) -> Self

Trait Implementations

impl Clone for ReceiptsTransferOutSubject

fn clone(&self) -> ReceiptsTransferOutSubject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiptsTransferOutSubject

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

Formats the value using the given formatter.

impl Default for ReceiptsTransferOutSubject

fn default() -> ReceiptsTransferOutSubject

Returns the “default value” for a type.

impl Display for ReceiptsTransferOutSubject

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

Formats the value using the given formatter.

impl IntoSubject for ReceiptsTransferOutSubject

fn parse(&self) -> String

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

impl SubjectBuildable for ReceiptsTransferOutSubject

fn new() -> Self