Struct ReceiptsBurnSubject

pub struct ReceiptsBurnSubject {
    pub tx_id: Option<Bytes32>,
    pub index: Option<usize>,
    pub contract_id: Option<ContractId>,
    pub sub_id: Option<Bytes32>,
}

Represents a subject for burn receipts in the Fuel network.

This subject format allows for efficient querying and filtering of burn receipts based on the transaction ID (tx_id), index (index), contract ID (contract_id), and sub ID (sub_id).

Examples

Creating a subject for a specific burn receipt:

let subject = ReceiptsBurnSubject {
    tx_id: Some(Bytes32::from([1u8; 32])),
    index: Some(0),
    contract_id: Some(ContractId::from([2u8; 32])),
    sub_id: Some(Bytes32::from([3u8; 32])),
};
assert_eq!(
    subject.parse(),
    "receipts.0x0101010101010101010101010101010101010101010101010101010101010101.0.burn.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303"
);

Wildcard for querying all burn receipts:

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

Creating a subject query using the wildcard method:

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

Using the builder pattern:

let subject = ReceiptsBurnSubject::new()
    .with_tx_id(Some(Bytes32::from([1u8; 32])))
    .with_index(Some(0))
    .with_contract_id(Some(ContractId::from([2u8; 32])))
    .with_sub_id(Some(Bytes32::from([3u8; 32])));
assert_eq!(
    subject.parse(),
    "receipts.0x0101010101010101010101010101010101010101010101010101010101010101.0.burn.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303"
);

Fields

tx_id: Option<Bytes32>

index: Option<usize>

contract_id: Option<ContractId>

sub_id: Option<Bytes32>

Implementations

impl ReceiptsBurnSubject

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

pub fn build( tx_id: Option<Bytes32>, index: Option<usize>, contract_id: Option<ContractId>, sub_id: Option<Bytes32>, ) -> Self

pub fn wildcard( tx_id: Option<Bytes32>, index: Option<usize>, contract_id: Option<ContractId>, sub_id: Option<Bytes32>, ) -> 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_contract_id(self, value: Option<ContractId>) -> Self

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

Trait Implementations

impl Clone for ReceiptsBurnSubject

fn clone(&self) -> ReceiptsBurnSubject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiptsBurnSubject

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

Formats the value using the given formatter.

impl Default for ReceiptsBurnSubject

fn default() -> ReceiptsBurnSubject

Returns the “default value” for a type.

impl Display for ReceiptsBurnSubject

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

Formats the value using the given formatter.

impl IntoSubject for ReceiptsBurnSubject

fn parse(&self) -> String

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

impl SubjectBuildable for ReceiptsBurnSubject

fn new() -> Self