fuel_streams_core/inputs/subjects.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
use fuel_streams_macros::subject::{IntoSubject, Subject};
use crate::types::*;
/// Represents a subject for querying inputs by their identifier in the Fuel ecosystem.
///
/// This struct is used to create and parse subjects related to inputs identified by
/// various types of IDs, which can be used for subscribing to or publishing events
/// about specific inputs.
///
/// # Examples
///
/// Creating and parsing a subject:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsByIdSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let subject = InputsByIdSubject {
/// 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.inputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.asset_id.0x0303030303030303030303030303030303030303030303030303030303030303"
/// );
/// ```
///
/// All inputs by ID wildcard:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsByIdSubject;
/// # use fuel_streams_macros::subject::*;
/// assert_eq!(InputsByIdSubject::WILDCARD, "by_id.inputs.>");
/// ```
///
/// Creating a subject query using the `wildcard` method:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsByIdSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let wildcard = InputsByIdSubject::wildcard(Some([1u8; 32].into()), Some(0), Some(IdentifierKind::AssetID), None);
/// assert_eq!(wildcard, "by_id.inputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.asset_id.*");
/// ```
///
/// Using the builder pattern:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsByIdSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let subject = InputsByIdSubject::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.inputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.asset_id.0x0303030303030303030303030303030303030303030303030303030303030303");
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "by_id.inputs.>"]
#[subject_format = "by_id.inputs.{tx_id}.{index}.{id_kind}.{id_value}"]
pub struct InputsByIdSubject {
pub tx_id: Option<Bytes32>,
pub index: Option<u8>,
pub id_kind: Option<IdentifierKind>,
pub id_value: Option<Bytes32>,
}
/// Represents a subject for input coins in the Fuel network.
///
/// This subject format allows for efficient querying and filtering of input coins
/// based on their transaction ID, index, owner, and asset ID.
///
/// # Examples
///
/// Creating a subject for a specific input coin:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsCoinSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let subject = InputsCoinSubject {
/// tx_id: Some(Bytes32::from([1u8; 32])),
/// index: Some(0),
/// owner: Some(Address::from([2u8; 32])),
/// asset_id: Some(AssetId::from([3u8; 32])),
/// };
/// assert_eq!(
/// subject.parse(),
/// "inputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.coin.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303"
/// );
/// ```
///
/// All input coins wildcard:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsCoinSubject;
/// # use fuel_streams_macros::subject::*;
/// assert_eq!(InputsCoinSubject::WILDCARD, "inputs.>");
/// ```
///
/// Creating a subject query using the `wildcard` method:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsCoinSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let wildcard = InputsCoinSubject::wildcard(None, Some(0), None, Some(AssetId::from([3u8; 32])));
/// assert_eq!(wildcard, "inputs.*.0.coin.*.0x0303030303030303030303030303030303030303030303030303030303030303");
/// ```
///
/// Using the builder pattern:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsCoinSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let subject = InputsCoinSubject::new()
/// .with_tx_id(Some(Bytes32::from([1u8; 32])))
/// .with_index(Some(0))
/// .with_owner(Some(Address::from([2u8; 32])))
/// .with_asset_id(Some(AssetId::from([3u8; 32])));
/// assert_eq!(subject.parse(), "inputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.coin.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303");
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "inputs.>"]
#[subject_format = "inputs.{tx_id}.{index}.coin.{owner}.{asset_id}"]
pub struct InputsCoinSubject {
pub tx_id: Option<Bytes32>,
pub index: Option<usize>,
pub owner: Option<Address>,
pub asset_id: Option<AssetId>,
}
/// Represents a subject for input contracts in the Fuel network.
///
/// This subject format allows for efficient querying and filtering of input contracts
/// based on their transaction ID, index, and contract ID.
///
/// # Examples
///
/// Creating a subject for a specific input contract:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsContractSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let subject = InputsContractSubject {
/// tx_id: Some(Bytes32::from([1u8; 32])),
/// index: Some(0),
/// contract_id: Some(ContractId::from([4u8; 32])),
/// };
/// assert_eq!(
/// subject.parse(),
/// "inputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.contract.0x0404040404040404040404040404040404040404040404040404040404040404"
/// );
/// ```
///
/// All input contracts wildcard:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsContractSubject;
/// # use fuel_streams_macros::subject::*;
/// assert_eq!(InputsContractSubject::WILDCARD, "inputs.>");
/// ```
///
/// Creating a subject query using the `wildcard` method:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsContractSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let wildcard = InputsContractSubject::wildcard(Some(Bytes32::from([1u8; 32])), None, None);
/// assert_eq!(wildcard, "inputs.0x0101010101010101010101010101010101010101010101010101010101010101.*.contract.*");
/// ```
///
/// Using the builder pattern:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsContractSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let subject = InputsContractSubject::new()
/// .with_tx_id(Some(Bytes32::from([1u8; 32])))
/// .with_index(Some(0))
/// .with_contract_id(Some(ContractId::from([4u8; 32])));
/// assert_eq!(subject.parse(), "inputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.contract.0x0404040404040404040404040404040404040404040404040404040404040404");
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "inputs.>"]
#[subject_format = "inputs.{tx_id}.{index}.contract.{contract_id}"]
pub struct InputsContractSubject {
pub tx_id: Option<Bytes32>,
pub index: Option<usize>,
pub contract_id: Option<ContractId>,
}
/// Represents a subject for input messages in the Fuel ecosystem.
///
/// This struct is used to create and parse subjects related to input messages,
/// which can be used for subscribing to or publishing events about input messages.
///
/// # Examples
///
/// Creating and parsing a subject:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsMessageSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let subject = InputsMessageSubject {
/// 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(),
/// "inputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.message.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303"
/// );
/// ```
///
/// All input messages wildcard:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsMessageSubject;
/// # use fuel_streams_macros::subject::*;
/// assert_eq!(InputsMessageSubject::WILDCARD, "inputs.>");
/// ```
///
/// Creating a subject query using the `wildcard` method:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsMessageSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let wildcard = InputsMessageSubject::wildcard(Some(Bytes32::from([1u8; 32])), None, None, None);
/// assert_eq!(wildcard, "inputs.0x0101010101010101010101010101010101010101010101010101010101010101.*.message.*.*");
/// ```
///
/// Using the builder pattern:
///
/// ```
/// # use fuel_streams_core::inputs::subjects::InputsMessageSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let subject = InputsMessageSubject::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(), "inputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.message.0x0202020202020202020202020202020202020202020202020202020202020202.0x0303030303030303030303030303030303030303030303030303030303030303");
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "inputs.>"]
#[subject_format = "inputs.{tx_id}.{index}.message.{sender}.{recipient}"]
pub struct InputsMessageSubject {
pub tx_id: Option<Bytes32>,
pub index: Option<usize>,
pub sender: Option<Address>,
pub recipient: Option<Address>,
}