pub struct BasicOutput { /* private fields */ }
Expand description
Describes a basic output with optional features.
Implementations§
source§impl BasicOutput
impl BasicOutput
pub fn try_from_dtos<'a>( amount: OutputBuilderAmountDto, native_tokens: Option<Vec<NativeToken>>, unlock_conditions: Vec<UnlockConditionDto>, features: Option<Vec<FeatureDto>>, params: impl Into<ValidationParams<'a>> + Send ) -> Result<Self, Error>
source§impl BasicOutput
impl BasicOutput
sourcepub const KIND: u8 = 3u8
pub const KIND: u8 = 3u8
The Output
kind of an BasicOutput
.
sourcepub const ALLOWED_FEATURES: FeatureFlags = _
pub const ALLOWED_FEATURES: FeatureFlags = _
The set of allowed Feature
s for an BasicOutput
.
sourcepub fn build_with_amount(amount: u64) -> BasicOutputBuilder
pub fn build_with_amount(amount: u64) -> BasicOutputBuilder
Creates a new BasicOutputBuilder
with a provided amount.
sourcepub fn build_with_minimum_storage_deposit(
rent_structure: RentStructure
) -> BasicOutputBuilder
pub fn build_with_minimum_storage_deposit( rent_structure: RentStructure ) -> BasicOutputBuilder
Creates a new BasicOutputBuilder
with a provided rent structure.
The amount will be set to the minimum storage deposit.
sourcepub fn native_tokens(&self) -> &NativeTokens
pub fn native_tokens(&self) -> &NativeTokens
sourcepub fn unlock_conditions(&self) -> &UnlockConditions
pub fn unlock_conditions(&self) -> &UnlockConditions
sourcepub fn unlock(
&self,
_output_id: &OutputId,
unlock: &Unlock,
inputs: &[(&OutputId, &Output)],
context: &mut ValidationContext<'_>
) -> Result<(), ConflictReason>
pub fn unlock( &self, _output_id: &OutputId, unlock: &Unlock, inputs: &[(&OutputId, &Output)], context: &mut ValidationContext<'_> ) -> Result<(), ConflictReason>
sourcepub fn simple_deposit_address(&self) -> Option<&Address>
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§
source§impl Clone for BasicOutput
impl Clone for BasicOutput
source§fn clone(&self) -> BasicOutput
fn clone(&self) -> BasicOutput
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for BasicOutput
impl Debug for BasicOutput
source§impl From<&BasicOutput> for BasicOutputBuilder
impl From<&BasicOutput> for BasicOutputBuilder
source§fn from(output: &BasicOutput) -> Self
fn from(output: &BasicOutput) -> Self
Converts to this type from the input type.
source§impl From<&BasicOutput> for BasicOutputDto
impl From<&BasicOutput> for BasicOutputDto
source§fn from(value: &BasicOutput) -> Self
fn from(value: &BasicOutput) -> Self
Converts to this type from the input type.
source§impl From<BasicOutput> for Output
impl From<BasicOutput> for Output
source§fn from(original: BasicOutput) -> Output
fn from(original: BasicOutput) -> Output
Converts to this type from the input type.
source§impl Hash for BasicOutput
impl Hash for BasicOutput
source§impl Ord for BasicOutput
impl Ord for BasicOutput
source§fn cmp(&self, other: &BasicOutput) -> Ordering
fn cmp(&self, other: &BasicOutput) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
source§impl Packable for BasicOutput
impl Packable for BasicOutput
§type UnpackError = Error
type UnpackError = Error
The error type that can be returned if some semantic error occurs while unpacking. Read more
§type UnpackVisitor = ProtocolParameters
type UnpackVisitor = ProtocolParameters
FIXME: docs
source§fn pack<P: Packer>(&self, packer: &mut P) -> Result<(), P::Error>
fn pack<P: Packer>(&self, packer: &mut P) -> Result<(), P::Error>
Packs this value into the given
Packer
.source§fn unpack<U: Unpacker, const VERIFY: bool>(
unpacker: &mut U,
visitor: &Self::UnpackVisitor
) -> Result<Self, UnpackError<Self::UnpackError, U::Error>>
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.source§impl PartialEq for BasicOutput
impl PartialEq for BasicOutput
source§fn eq(&self, other: &BasicOutput) -> bool
fn eq(&self, other: &BasicOutput) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for BasicOutput
impl PartialOrd for BasicOutput
source§fn partial_cmp(&self, other: &BasicOutput) -> Option<Ordering>
fn partial_cmp(&self, other: &BasicOutput) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moresource§impl TryFromDto for BasicOutput
impl TryFromDto for BasicOutput
type Dto = BasicOutputDto
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 BasicOutput
impl StructuralPartialEq for BasicOutput
Auto Trait Implementations§
impl Freeze for BasicOutput
impl RefUnwindSafe for BasicOutput
impl Send for BasicOutput
impl Sync for BasicOutput
impl Unpin for BasicOutput
impl UnwindSafe for BasicOutput
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
Mutably borrows from an owned value. Read more
source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.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>
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 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>
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 moresource§impl<P> PackableExt for Pwhere
P: Packable,
impl<P> PackableExt for Pwhere
P: Packable,
source§fn unpack_verified<T>(
bytes: T,
visitor: &<P as Packable>::UnpackVisitor
) -> Result<P, UnpackError<<P as Packable>::UnpackError, UnexpectedEOF>>
fn unpack_verified<T>( bytes: T, visitor: &<P as Packable>::UnpackVisitor ) -> Result<P, UnpackError<<P as Packable>::UnpackError, UnexpectedEOF>>
Unpacks this value from a type that implements [AsRef<[u8]>
].
source§fn unpack_unverified<T>(
bytes: T
) -> Result<P, UnpackError<<P as Packable>::UnpackError, UnexpectedEOF>>
fn unpack_unverified<T>( bytes: T ) -> Result<P, UnpackError<<P as Packable>::UnpackError, UnexpectedEOF>>
Unpacks this value from a type that implements [AsRef<[u8]>
] skipping some syntatical checks.
source§fn packed_len(&self) -> usize
fn packed_len(&self) -> usize
Returns the length in bytes of the value after being packed. The returned value always matches the number of
bytes written using
pack
.