iota_sdk::client::api::input_selection

Struct Burn

pub struct Burn { /* private fields */ }

Available on crate feature client only.

Expand description

A type to specify what needs to be burned during input selection. Nothing will be burned that has not been explicitly set with this struct.

Implementations§

impl Burn

pub fn new() -> Self

Creates a new Burn.

pub fn add_alias(self, alias_id: AliasId) -> Self

Adds an alias to Burn.

pub fn set_aliases(self, aliases: HashSet<AliasId>) -> Self

Sets the aliases to Burn.

pub fn aliases(&self) -> &HashSet<AliasId>

Returns the aliases to Burn.

pub fn add_nft(self, nft_id: NftId) -> Self

Adds an NFT to Burn.

pub fn set_nfts(self, nfts: HashSet<NftId>) -> Self

Sets the NFTs to Burn.

pub fn nfts(&self) -> &HashSet<NftId>

Returns the NFTs to Burn.

pub fn add_foundry(self, foundry_id: FoundryId) -> Self

Adds a foundry to Burn.

pub fn set_foundries(self, foundries: HashSet<FoundryId>) -> Self

Sets the foundries to Burn.

pub fn foundries(&self) -> &HashSet<FoundryId>

Returns the foundries to Burn.

pub fn add_native_token( self, token_id: TokenId, amount: impl Into<U256>, ) -> Self

Adds an amount of native token to Burn.

pub fn set_native_tokens( self, native_tokens: HashMap<TokenId, impl Into<U256>>, ) -> Self

Sets the amounts of native tokens to Burn.

pub fn native_tokens(&self) -> &BTreeMap<TokenId, U256>

Returns the native tokens to Burn.

Trait Implementations§

impl Clone for Burn

fn clone(&self) -> Burn

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Burn

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

Formats the value using the given formatter. Read more

impl Default for Burn

fn default() -> Burn

Returns the “default value” for a type. Read more

impl From<&Burn> for BurnDto

fn from(value: &Burn) -> Self

Converts to this type from the input type.

impl From<AliasId> for Burn

fn from(id: AliasId) -> Self

Converts to this type from the input type.

impl From<BurnDto> for Burn

fn from(value: BurnDto) -> Self

Converts to this type from the input type.

impl From<FoundryId> for Burn

fn from(id: FoundryId) -> Self

Converts to this type from the input type.

impl From<NativeToken> for Burn

fn from(native_token: NativeToken) -> Self

Converts to this type from the input type.

impl From<NftId> for Burn

fn from(id: NftId) -> Self

Converts to this type from the input type.

impl PartialEq for Burn

fn eq(&self, other: &Burn) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Burn

impl StructuralPartialEq for Burn

Auto Trait Implementations§

impl Freeze for Burn

impl RefUnwindSafe for Burn

impl Send for Burn

impl Sync for Burn

impl Unpin for Burn

impl UnwindSafe for Burn

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> ConvertTo<T> for T
where T: Send,

fn convert(self) -> Result<T, Error>

fn convert_unchecked(self) -> T

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> Any for T
where T: Any,

impl<T> CloneAny for T
where T: Any + Clone,

impl<T> ErasedDestructor for T
where T: 'static,