Struct ReceiptsByIdSubject

pub struct ReceiptsByIdSubject {
    pub tx_id: Option<Bytes32>,
    pub index: Option<u8>,
    pub id_kind: Option<IdentifierKind>,
    pub id_value: Option<Bytes32>,
}

Represents a subject for querying receipts by their identifier in the Fuel ecosystem.

This struct is used to create and parse subjects related to receipts identified by various types of IDs, which can be used for subscribing to or publishing events about specific receipts.

Examples

Creating and parsing a subject:

let subject = ReceiptsByIdSubject {
    tx_id: Some([1u8; 32].into()),
    index: Some(0),
    id_kind: Some(IdentifierKind::ContractID),
    id_value: Some([2u8; 32].into()),
};
assert_eq!(
    subject.parse(),
    "by_id.receipts.0x0101010101010101010101010101010101010101010101010101010101010101.0.contract_id.0x0202020202020202020202020202020202020202020202020202020202020202"
);

All receipts by ID wildcard:

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

Creating a subject query using the wildcard method:

let wildcard = ReceiptsByIdSubject::wildcard(Some([1u8; 32].into()), Some(0), Some(IdentifierKind::ContractID), None);
assert_eq!(wildcard, "by_id.receipts.0x0101010101010101010101010101010101010101010101010101010101010101.0.contract_id.*");

Using the builder pattern:

let subject = ReceiptsByIdSubject::new()
    .with_tx_id(Some([1u8; 32].into()))
    .with_index(Some(0))
    .with_id_kind(Some(IdentifierKind::ContractID))
    .with_id_value(Some([2u8; 32].into()));
assert_eq!(subject.parse(), "by_id.receipts.0x0101010101010101010101010101010101010101010101010101010101010101.0.contract_id.0x0202020202020202020202020202020202020202020202020202020202020202");

Fields

tx_id: Option<Bytes32>

index: Option<u8>

id_kind: Option<IdentifierKind>

id_value: Option<Bytes32>

Implementations

impl ReceiptsByIdSubject

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

pub fn build( tx_id: Option<Bytes32>, index: Option<u8>, id_kind: Option<IdentifierKind>, id_value: Option<Bytes32>, ) -> Self

pub fn wildcard( tx_id: Option<Bytes32>, index: Option<u8>, id_kind: Option<IdentifierKind>, id_value: 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<u8>) -> Self

pub fn with_id_kind(self, value: Option<IdentifierKind>) -> Self

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

Trait Implementations

impl Clone for ReceiptsByIdSubject

fn clone(&self) -> ReceiptsByIdSubject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiptsByIdSubject

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

Formats the value using the given formatter.

impl Default for ReceiptsByIdSubject

fn default() -> ReceiptsByIdSubject

Returns the “default value” for a type.

impl Display for ReceiptsByIdSubject

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

Formats the value using the given formatter.

impl IntoSubject for ReceiptsByIdSubject

fn parse(&self) -> String

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

impl SubjectBuildable for ReceiptsByIdSubject

fn new() -> Self