Struct OutputsByIdSubject

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

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

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

Examples

Creating and parsing a subject:

let subject = OutputsByIdSubject {
    tx_id: Some([1u8; 32].into()),
    index: Some(0),
    id_kind: Some(IdentifierKind::AssetID),
    id_value: Some([3u8; 32].into()),
};
assert_eq!(
    subject.parse(),
    "by_id.outputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.asset_id.0x0303030303030303030303030303030303030303030303030303030303030303"
);

All outputs by ID wildcard:

assert_eq!(OutputsByIdSubject::WILDCARD, "by_id.outputs.>");

Creating a subject query using the wildcard method:

let wildcard = OutputsByIdSubject::wildcard(Some([1u8; 32].into()), Some(0), Some(IdentifierKind::AssetID), None);
assert_eq!(wildcard, "by_id.outputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.asset_id.*");

Using the builder pattern:

let subject = OutputsByIdSubject::new()
    .with_tx_id(Some([1u8; 32].into()))
    .with_index(Some(0))
    .with_id_kind(Some(IdentifierKind::AssetID))
    .with_id_value(Some([3u8; 32].into()));
assert_eq!(subject.parse(), "by_id.outputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.asset_id.0x0303030303030303030303030303030303030303030303030303030303030303");

Fields

tx_id: Option<Bytes32>

index: Option<u8>

id_kind: Option<IdentifierKind>

id_value: Option<Bytes32>

Implementations

impl OutputsByIdSubject

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

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 OutputsByIdSubject

fn clone(&self) -> OutputsByIdSubject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OutputsByIdSubject

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

Formats the value using the given formatter.

impl Default for OutputsByIdSubject

fn default() -> OutputsByIdSubject

Returns the “default value” for a type.

impl Display for OutputsByIdSubject

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

Formats the value using the given formatter.

impl IntoSubject for OutputsByIdSubject

fn parse(&self) -> String

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

impl SubjectBuildable for OutputsByIdSubject

fn new() -> Self