Struct bee_block::output::basic::BasicOutput

pub struct BasicOutput { /* private fields */ }

Describes a basic output with optional features.

Implementations

impl BasicOutput

pub fn try_from_dto(
    value: &BasicOutputDto,
    token_supply: u64
) -> Result<BasicOutput, DtoError>

pub fn try_from_dtos(
    amount: OutputBuilderAmountDto,
    native_tokens: Option<Vec<NativeTokenDto>>,
    unlock_conditions: Vec<UnlockConditionDto>,
    features: Option<Vec<FeatureDto>>,
    token_supply: u64
) -> Result<BasicOutput, DtoError>

impl BasicOutput

pub const KIND: u8 = 3u8

The Output kind of an BasicOutput.

pub const ALLOWED_FEATURES: FeatureFlags = _

The set of allowed Features for an BasicOutput.

pub fn new_with_amount(amount: u64, token_supply: u64) -> Result<Self, Error>

Creates a new BasicOutput with a provided amount.

pub fn new_with_minimum_storage_deposit(
    rent_structure: RentStructure,
    token_supply: u64
) -> Result<Self, Error>

Creates a new BasicOutput with a provided rent structure. The amount will be set to the minimum storage deposit.

pub fn build_with_amount(amount: u64) -> Result<BasicOutputBuilder, Error>

Creates a new BasicOutputBuilder with a provided amount.

pub fn build_with_minimum_storage_deposit(
    rent_structure: RentStructure
) -> Result<BasicOutputBuilder, Error>

Creates a new BasicOutputBuilder with a provided rent structure. The amount will be set to the minimum storage deposit.

pub fn amount(&self) -> u64

pub fn native_tokens(&self) -> &NativeTokens

pub fn unlock_conditions(&self) -> &UnlockConditions

pub fn features(&self) -> &Features

pub fn address(&self) -> &Address

pub fn unlock(
    &self,
    _output_id: &OutputId,
    unlock: &Unlock,
    inputs: &[(OutputId, &Output)],
    context: &mut ValidationContext<'_>
) -> Result<(), ConflictReason>

pub fn simple_deposit_address(&self) -> Option<&Address>

Returns the address of the unlock conditions if the output is a simple deposit. Simple deposit outputs are basic outputs with only an address unlock condition, no native tokens and no features. They are used to return storage deposits.

Trait Implementations

impl Clone for BasicOutput

fn clone(&self) -> BasicOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasicOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BasicOutput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&BasicOutput> for BasicOutputBuilder

fn from(output: &BasicOutput) -> Self

Converts to this type from the input type.

impl From<&BasicOutput> for BasicOutputDto

fn from(value: &BasicOutput) -> Self

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 Ord for BasicOutput

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl Packable for BasicOutput

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<BasicOutput> for BasicOutput

fn eq(&self, other: &BasicOutput) -> 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<BasicOutput> for BasicOutput

fn partial_cmp(&self, other: &BasicOutput) -> 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 Serialize for BasicOutput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BasicOutput

impl StructuralEq for BasicOutput

impl StructuralPartialEq for BasicOutput