#[non_exhaustive]pub struct TransactionBuilder { /* private fields */ }
Expand description
A builder for Transaction
.
Implementations§
Source§impl TransactionBuilder
impl TransactionBuilder
Sourcepub fn network(self, input: QueryNetwork) -> Self
pub fn network(self, input: QueryNetwork) -> Self
The blockchain network where the transaction occurred.
This field is required.Sourcepub fn set_network(self, input: Option<QueryNetwork>) -> Self
pub fn set_network(self, input: Option<QueryNetwork>) -> Self
The blockchain network where the transaction occurred.
Sourcepub fn get_network(&self) -> &Option<QueryNetwork>
pub fn get_network(&self) -> &Option<QueryNetwork>
The blockchain network where the transaction occurred.
Sourcepub fn block_hash(self, input: impl Into<String>) -> Self
pub fn block_hash(self, input: impl Into<String>) -> Self
The block hash is a unique identifier for a block. It is a fixed-size string that is calculated by using the information in the block. The block hash is used to verify the integrity of the data in the block.
Sourcepub fn set_block_hash(self, input: Option<String>) -> Self
pub fn set_block_hash(self, input: Option<String>) -> Self
The block hash is a unique identifier for a block. It is a fixed-size string that is calculated by using the information in the block. The block hash is used to verify the integrity of the data in the block.
Sourcepub fn get_block_hash(&self) -> &Option<String>
pub fn get_block_hash(&self) -> &Option<String>
The block hash is a unique identifier for a block. It is a fixed-size string that is calculated by using the information in the block. The block hash is used to verify the integrity of the data in the block.
Sourcepub fn transaction_hash(self, input: impl Into<String>) -> Self
pub fn transaction_hash(self, input: impl Into<String>) -> Self
The hash of a transaction. It is generated when a transaction is created.
This field is required.Sourcepub fn set_transaction_hash(self, input: Option<String>) -> Self
pub fn set_transaction_hash(self, input: Option<String>) -> Self
The hash of a transaction. It is generated when a transaction is created.
Sourcepub fn get_transaction_hash(&self) -> &Option<String>
pub fn get_transaction_hash(&self) -> &Option<String>
The hash of a transaction. It is generated when a transaction is created.
Sourcepub fn block_number(self, input: impl Into<String>) -> Self
pub fn block_number(self, input: impl Into<String>) -> Self
The block number in which the transaction is recorded.
Sourcepub fn set_block_number(self, input: Option<String>) -> Self
pub fn set_block_number(self, input: Option<String>) -> Self
The block number in which the transaction is recorded.
Sourcepub fn get_block_number(&self) -> &Option<String>
pub fn get_block_number(&self) -> &Option<String>
The block number in which the transaction is recorded.
Sourcepub fn transaction_timestamp(self, input: DateTime) -> Self
pub fn transaction_timestamp(self, input: DateTime) -> Self
The Timestamp
of the transaction.
Sourcepub fn set_transaction_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_transaction_timestamp(self, input: Option<DateTime>) -> Self
The Timestamp
of the transaction.
Sourcepub fn get_transaction_timestamp(&self) -> &Option<DateTime>
pub fn get_transaction_timestamp(&self) -> &Option<DateTime>
The Timestamp
of the transaction.
Sourcepub fn transaction_index(self, input: i64) -> Self
pub fn transaction_index(self, input: i64) -> Self
The index of the transaction within a blockchain.
This field is required.Sourcepub fn set_transaction_index(self, input: Option<i64>) -> Self
pub fn set_transaction_index(self, input: Option<i64>) -> Self
The index of the transaction within a blockchain.
Sourcepub fn get_transaction_index(&self) -> &Option<i64>
pub fn get_transaction_index(&self) -> &Option<i64>
The index of the transaction within a blockchain.
Sourcepub fn number_of_transactions(self, input: i64) -> Self
pub fn number_of_transactions(self, input: i64) -> Self
The number of transactions in the block.
This field is required.Sourcepub fn set_number_of_transactions(self, input: Option<i64>) -> Self
pub fn set_number_of_transactions(self, input: Option<i64>) -> Self
The number of transactions in the block.
Sourcepub fn get_number_of_transactions(&self) -> &Option<i64>
pub fn get_number_of_transactions(&self) -> &Option<i64>
The number of transactions in the block.
Sourcepub fn to(self, input: impl Into<String>) -> Self
pub fn to(self, input: impl Into<String>) -> Self
The identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
This field is required.Sourcepub fn set_to(self, input: Option<String>) -> Self
pub fn set_to(self, input: Option<String>) -> Self
The identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
Sourcepub fn get_to(&self) -> &Option<String>
pub fn get_to(&self) -> &Option<String>
The identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
Sourcepub fn from(self, input: impl Into<String>) -> Self
pub fn from(self, input: impl Into<String>) -> Self
The initiator of the transaction. It is either in the form a public key or a contract address.
Sourcepub fn set_from(self, input: Option<String>) -> Self
pub fn set_from(self, input: Option<String>) -> Self
The initiator of the transaction. It is either in the form a public key or a contract address.
Sourcepub fn get_from(&self) -> &Option<String>
pub fn get_from(&self) -> &Option<String>
The initiator of the transaction. It is either in the form a public key or a contract address.
Sourcepub fn contract_address(self, input: impl Into<String>) -> Self
pub fn contract_address(self, input: impl Into<String>) -> Self
The blockchain address for the contract.
Sourcepub fn set_contract_address(self, input: Option<String>) -> Self
pub fn set_contract_address(self, input: Option<String>) -> Self
The blockchain address for the contract.
Sourcepub fn get_contract_address(&self) -> &Option<String>
pub fn get_contract_address(&self) -> &Option<String>
The blockchain address for the contract.
Sourcepub fn gas_used(self, input: impl Into<String>) -> Self
pub fn gas_used(self, input: impl Into<String>) -> Self
The amount of gas used for the transaction.
Sourcepub fn set_gas_used(self, input: Option<String>) -> Self
pub fn set_gas_used(self, input: Option<String>) -> Self
The amount of gas used for the transaction.
Sourcepub fn get_gas_used(&self) -> &Option<String>
pub fn get_gas_used(&self) -> &Option<String>
The amount of gas used for the transaction.
Sourcepub fn cumulative_gas_used(self, input: impl Into<String>) -> Self
pub fn cumulative_gas_used(self, input: impl Into<String>) -> Self
The amount of gas used up to the specified point in the block.
Sourcepub fn set_cumulative_gas_used(self, input: Option<String>) -> Self
pub fn set_cumulative_gas_used(self, input: Option<String>) -> Self
The amount of gas used up to the specified point in the block.
Sourcepub fn get_cumulative_gas_used(&self) -> &Option<String>
pub fn get_cumulative_gas_used(&self) -> &Option<String>
The amount of gas used up to the specified point in the block.
Sourcepub fn effective_gas_price(self, input: impl Into<String>) -> Self
pub fn effective_gas_price(self, input: impl Into<String>) -> Self
The effective gas price.
Sourcepub fn set_effective_gas_price(self, input: Option<String>) -> Self
pub fn set_effective_gas_price(self, input: Option<String>) -> Self
The effective gas price.
Sourcepub fn get_effective_gas_price(&self) -> &Option<String>
pub fn get_effective_gas_price(&self) -> &Option<String>
The effective gas price.
Sourcepub fn signature_v(self, input: i32) -> Self
pub fn signature_v(self, input: i32) -> Self
The signature of the transaction. The Z coordinate of a point V.
Sourcepub fn set_signature_v(self, input: Option<i32>) -> Self
pub fn set_signature_v(self, input: Option<i32>) -> Self
The signature of the transaction. The Z coordinate of a point V.
Sourcepub fn get_signature_v(&self) -> &Option<i32>
pub fn get_signature_v(&self) -> &Option<i32>
The signature of the transaction. The Z coordinate of a point V.
Sourcepub fn signature_r(self, input: impl Into<String>) -> Self
pub fn signature_r(self, input: impl Into<String>) -> Self
The signature of the transaction. The X coordinate of a point R.
Sourcepub fn set_signature_r(self, input: Option<String>) -> Self
pub fn set_signature_r(self, input: Option<String>) -> Self
The signature of the transaction. The X coordinate of a point R.
Sourcepub fn get_signature_r(&self) -> &Option<String>
pub fn get_signature_r(&self) -> &Option<String>
The signature of the transaction. The X coordinate of a point R.
Sourcepub fn signature_s(self, input: impl Into<String>) -> Self
pub fn signature_s(self, input: impl Into<String>) -> Self
The signature of the transaction. The Y coordinate of a point S.
Sourcepub fn set_signature_s(self, input: Option<String>) -> Self
pub fn set_signature_s(self, input: Option<String>) -> Self
The signature of the transaction. The Y coordinate of a point S.
Sourcepub fn get_signature_s(&self) -> &Option<String>
pub fn get_signature_s(&self) -> &Option<String>
The signature of the transaction. The Y coordinate of a point S.
Sourcepub fn transaction_fee(self, input: impl Into<String>) -> Self
pub fn transaction_fee(self, input: impl Into<String>) -> Self
The transaction fee.
Sourcepub fn set_transaction_fee(self, input: Option<String>) -> Self
pub fn set_transaction_fee(self, input: Option<String>) -> Self
The transaction fee.
Sourcepub fn get_transaction_fee(&self) -> &Option<String>
pub fn get_transaction_fee(&self) -> &Option<String>
The transaction fee.
Sourcepub fn transaction_id(self, input: impl Into<String>) -> Self
pub fn transaction_id(self, input: impl Into<String>) -> Self
The identifier of a Bitcoin transaction. It is generated when a transaction is created.
Sourcepub fn set_transaction_id(self, input: Option<String>) -> Self
pub fn set_transaction_id(self, input: Option<String>) -> Self
The identifier of a Bitcoin transaction. It is generated when a transaction is created.
Sourcepub fn get_transaction_id(&self) -> &Option<String>
pub fn get_transaction_id(&self) -> &Option<String>
The identifier of a Bitcoin transaction. It is generated when a transaction is created.
Sourcepub fn confirmation_status(self, input: ConfirmationStatus) -> Self
pub fn confirmation_status(self, input: ConfirmationStatus) -> Self
Specifies whether the transaction has reached Finality.
Sourcepub fn set_confirmation_status(self, input: Option<ConfirmationStatus>) -> Self
pub fn set_confirmation_status(self, input: Option<ConfirmationStatus>) -> Self
Specifies whether the transaction has reached Finality.
Sourcepub fn get_confirmation_status(&self) -> &Option<ConfirmationStatus>
pub fn get_confirmation_status(&self) -> &Option<ConfirmationStatus>
Specifies whether the transaction has reached Finality.
Sourcepub fn execution_status(self, input: ExecutionStatus) -> Self
pub fn execution_status(self, input: ExecutionStatus) -> Self
Identifies whether the transaction has succeeded or failed.
Sourcepub fn set_execution_status(self, input: Option<ExecutionStatus>) -> Self
pub fn set_execution_status(self, input: Option<ExecutionStatus>) -> Self
Identifies whether the transaction has succeeded or failed.
Sourcepub fn get_execution_status(&self) -> &Option<ExecutionStatus>
pub fn get_execution_status(&self) -> &Option<ExecutionStatus>
Identifies whether the transaction has succeeded or failed.
Sourcepub fn build(self) -> Result<Transaction, BuildError>
pub fn build(self) -> Result<Transaction, BuildError>
Consumes the builder and constructs a Transaction
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for TransactionBuilder
impl Clone for TransactionBuilder
Source§fn clone(&self) -> TransactionBuilder
fn clone(&self) -> TransactionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TransactionBuilder
impl Debug for TransactionBuilder
Source§impl Default for TransactionBuilder
impl Default for TransactionBuilder
Source§fn default() -> TransactionBuilder
fn default() -> TransactionBuilder
Source§impl PartialEq for TransactionBuilder
impl PartialEq for TransactionBuilder
impl StructuralPartialEq for TransactionBuilder
Auto Trait Implementations§
impl Freeze for TransactionBuilder
impl RefUnwindSafe for TransactionBuilder
impl Send for TransactionBuilder
impl Sync for TransactionBuilder
impl Unpin for TransactionBuilder
impl UnwindSafe for TransactionBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);