Enum iota_sdk::types::block::output::Output

pub enum Output {
    Treasury(TreasuryOutput),
    Basic(BasicOutput),
    Alias(AliasOutput),
    Foundry(FoundryOutput),
    Nft(NftOutput),
}

A generic output that can represent different types defining the deposit of funds.

Variants

Treasury(TreasuryOutput)

A treasury output.

Basic(BasicOutput)

A basic output.

Alias(AliasOutput)

An alias output.

Foundry(FoundryOutput)

A foundry output.

Nft(NftOutput)

An NFT output.

Implementations

impl Output

pub const AMOUNT_MIN: u64 = 1u64

Minimum amount for an output.

pub fn kind(&self) -> u8

Return the output kind of an Output.

pub fn kind_str(&self) -> &str

Returns the output kind of an Output as a string.

pub fn amount(&self) -> u64

Returns the amount of an Output.

pub fn native_tokens(&self) -> Option<&NativeTokens>

Returns the native tokens of an Output, if any.

pub fn unlock_conditions(&self) -> Option<&UnlockConditions>

Returns the unlock conditions of an Output, if any.

pub fn features(&self) -> Option<&Features>

Returns the features of an Output, if any.

pub fn immutable_features(&self) -> Option<&Features>

Returns the immutable features of an Output, if any.

pub fn chain_id(&self) -> Option<ChainId>

Returns the chain identifier of an Output, if any.

pub fn is_treasury(&self) -> bool

Checks whether the output is a TreasuryOutput.

pub fn as_treasury(&self) -> &TreasuryOutput

Gets the output as an actual TreasuryOutput. PANIC: do not call on a non-treasury output.

pub fn is_basic(&self) -> bool

Checks whether the output is a BasicOutput.

pub fn as_basic(&self) -> &BasicOutput

Gets the output as an actual BasicOutput. PANIC: do not call on a non-basic output.

pub fn is_alias(&self) -> bool

Checks whether the output is an AliasOutput.

pub fn as_alias(&self) -> &AliasOutput

Gets the output as an actual AliasOutput. PANIC: do not call on a non-alias output.

pub fn is_foundry(&self) -> bool

Checks whether the output is a FoundryOutput.

pub fn as_foundry(&self) -> &FoundryOutput

Gets the output as an actual FoundryOutput. PANIC: do not call on a non-foundry output.

pub fn is_nft(&self) -> bool

Checks whether the output is an NftOutput.

pub fn as_nft(&self) -> &NftOutput

Gets the output as an actual NftOutput. PANIC: do not call on a non-nft output.

pub fn required_and_unlocked_address( &self, current_time: u32, output_id: &OutputId, alias_transition: Option<AliasTransition> ) -> Result<(Address, Option<Address>), Error>

Returns the address that is required to unlock this Output and the alias or nft address that gets unlocked by it, if it’s an alias or nft. If no alias_transition has been provided, assumes a state transition.

pub fn verify_state_transition( current_state: Option<&Self>, next_state: Option<&Self>, context: &ValidationContext<'_> ) -> Result<(), StateTransitionError>

pub fn verify_storage_deposit( &self, rent_structure: RentStructure, token_supply: u64 ) -> Result<(), Error>

Verifies if a valid storage deposit was made. Each Output has to have an amount that covers its associated byte cost, given by RentStructure. If there is a StorageDepositReturnUnlockCondition, its amount is also checked.

Trait Implementations

impl Clone for Output

fn clone(&self) -> Output

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Output

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

Formats the value using the given formatter.

impl From<&Output> for OutputDto

fn from(value: &Output) -> Self

Converts to this type from the input type.

impl From<AliasOutput> for Output

fn from(original: AliasOutput) -> Output

Converts to this type from the input type.

impl From<BasicOutput> for Output

fn from(original: BasicOutput) -> Output

Converts to this type from the input type.

impl From<FoundryOutput> for Output

fn from(original: FoundryOutput) -> Output

Converts to this type from the input type.

impl From<NftOutput> for Output

fn from(original: NftOutput) -> Output

Converts to this type from the input type.

impl From<TreasuryOutput> for Output

fn from(original: TreasuryOutput) -> Output

Converts to this type from the input type.

impl Hash for Output

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Output

fn cmp(&self, other: &Output) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl Packable for Output

type UnpackError = Error

The error type that can be returned if some semantic error occurs while unpacking.

type UnpackVisitor = ProtocolParameters

FIXME: docs

fn pack<P: Packer>(&self, packer: &mut P) -> Result<(), P::Error>

Packs this value into the given Packer.

fn unpack<U: Unpacker, const VERIFY: bool>( unpacker: &mut U, visitor: &Self::UnpackVisitor ) -> Result<Self, UnpackError<Self::UnpackError, U::Error>>

Unpacks this value from the given Unpacker. The VERIFY generic parameter can be used to skip additional syntactic checks.

impl PartialEq for Output

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Output

fn partial_cmp(&self, other: &Output) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rent for Output

fn weighted_bytes(&self, rent_structure: &RentStructure) -> u64

Different fields in a type lead to different storage requirements for the ledger state.

fn rent_cost(&self, config: &RentStructure) -> u64

Computes the rent cost given a RentStructure.

impl TryFromDto for Output

type Dto = OutputDto

type Error = Error

fn try_from_dto_with_params_inner( dto: Self::Dto, params: ValidationParams<'_> ) -> Result<Self, Self::Error>

fn try_from_dto(dto: Self::Dto) -> Result<Self, Self::Error>

fn try_from_dto_with_params<'a>( dto: Self::Dto, params: impl Into<ValidationParams<'a>> + Send ) -> Result<Self, Self::Error>

impl Eq for Output

impl StructuralPartialEq for Output