Struct bee_block::output::AliasOutput

source · [−]

pub struct AliasOutput { /* private fields */ }

Expand description

Describes an alias account in the ledger that can be controlled by the state and governance controllers.

Implementations

source

impl AliasOutput

source

pub fn from_dtos(
 amount: OutputBuilderAmountDto,
 native_tokens: Option<Vec<NativeTokenDto>>,
 alias_id: &AliasIdDto,
 state_index: Option<u32>,
 state_metadata: Option<Vec<u8>>,
 foundry_counter: Option<u32>,
 unlock_conditions: Vec<UnlockConditionDto>,
 features: Option<Vec<FeatureDto>>,
 immutable_features: Option<Vec<FeatureDto>>
) -> Result<AliasOutput, DtoError>

source

impl AliasOutput

source

pub const KIND: u8 = 4u8

The Output kind of an AliasOutput.

source

pub const STATE_METADATA_LENGTH_MAX: u16 = 8_192u16

Maximum possible length in bytes of the state metadata.

source

pub const ALLOWED_UNLOCK_CONDITIONS: UnlockConditionFlags = _

The set of allowed UnlockConditions for an AliasOutput.

source

pub const ALLOWED_FEATURES: FeatureFlags = _

The set of allowed Features for an AliasOutput.

source

pub const ALLOWED_IMMUTABLE_FEATURES: FeatureFlags = _

The set of allowed immutable Features for an AliasOutput.

source

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

Creates a new AliasOutput with a provided amount.

source

pub fn new_with_minimum_storage_deposit(
rent_structure: RentStructure,
alias_id: AliasId
) -> Result<Self, Error>

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

source

pub fn build_with_amount(
amount: u64,
alias_id: AliasId
) -> Result<AliasOutputBuilder, Error>

Creates a new AliasOutputBuilder with a provided amount.

source

pub fn build_with_minimum_storage_deposit(
rent_structure: RentStructure,
alias_id: AliasId
) -> Result<AliasOutputBuilder, Error>

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

source

pub fn state_metadata(&self) -> &[u8]ⓘNotable traits for &mut [u8]`impl Write for &mut [u8]impl Read for &[u8]`

source

pub fn foundry_counter(&self) -> u32

source

pub fn unlock_conditions(&self) -> &UnlockConditions

source

pub fn features(&self) -> &Features

source

pub fn immutable_features(&self) -> &Features

source

pub fn state_controller_address(&self) -> &Address

source

pub fn governor_address(&self) -> &Address

source

pub fn chain_id(&self) -> ChainId

source

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

Trait Implementations

source

impl Clone for AliasOutput

source

fn clone(&self) -> AliasOutput

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

source

impl Debug for AliasOutput

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for AliasOutput

source

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

Deserialize this value from the given Serde deserializer. Read more

source

impl From<&AliasOutput> for AliasOutputBuilder

source

fn from(output: &AliasOutput) -> Self

Converts to this type from the input type.

source

impl From<&AliasOutput> for AliasOutputDto

source

fn from(value: &AliasOutput) -> Self

Converts to this type from the input type.

source

impl From<AliasOutput> for Output

source

fn from(original: AliasOutput) -> Output

Converts to this type from the input type.

source

impl Ord for AliasOutput

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl Packable for AliasOutput

type UnpackError = Error

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

source

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
) -> 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. Read more

source

impl PartialEq<AliasOutput> for AliasOutput

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<AliasOutput> for AliasOutput

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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 more

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl Serialize for AliasOutput

source

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

Serialize this value into the given Serde serializer. Read more

source

impl StateTransitionVerifier for AliasOutput

source

fn creation(
next_state: &Self,
context: &ValidationContext<'_>
) -> Result<(), StateTransitionError>

source

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

source

fn destruction(
_current_state: &Self,
_context: &ValidationContext<'_>
) -> Result<(), StateTransitionError>

source

impl TryFrom<&AliasOutputDto> for AliasOutput

type Error = DtoError

The type returned in the event of a conversion error.

source

fn try_from(value: &AliasOutputDto) -> Result<Self, Self::Error>

Performs the conversion.

source

impl Eq for AliasOutput

source

impl StructuralEq for AliasOutput

source

impl StructuralPartialEq for AliasOutput

Auto Trait Implementations

impl RefUnwindSafe for AliasOutput

impl Send for AliasOutput

impl Sync for AliasOutput

impl Unpin for AliasOutput

impl UnwindSafe for AliasOutput

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

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

source

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

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

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

source

impl<T> IntoRequest<T> for T

source

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

source

impl PackableExt for P where
P: Packable,

source

fn unpack_verified<T>(
bytes: T
) -> Result<P, UnpackError<::UnpackError, UnexpectedEOF>> where
T: AsRef<[u8]>,

Unpacks this value from a type that implements [AsRef<[u8]>].

source

fn unpack_unverified<T>(
bytes: T
) -> Result<P, UnpackError<::UnpackError, UnexpectedEOF>> where
T: AsRef<[u8]>,

Unpacks this value from a type that implements [AsRef<[u8]>] skipping some syntatical checks.

source

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. Read more

source

fn pack_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Convenience method that packs this value into a Vec<u8>.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

source

Struct bee_block::output::AliasOutput

Implementations

impl AliasOutput

impl AliasOutput

pub const KIND: u8 = 4u8

pub const STATE_METADATA_LENGTH_MAX: u16 = 8_192u16

pub const ALLOWED_UNLOCK_CONDITIONS: UnlockConditionFlags = _

pub const ALLOWED_FEATURES: FeatureFlags = _

pub const ALLOWED_IMMUTABLE_FEATURES: FeatureFlags = _

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

pub fn new_with_minimum_storage_deposit( rent_structure: RentStructure, alias_id: AliasId) -> Result<Self, Error>

pub fn build_with_amount( amount: u64, alias_id: AliasId) -> Result<AliasOutputBuilder, Error>

pub fn build_with_minimum_storage_deposit( rent_structure: RentStructure, alias_id: AliasId) -> Result<AliasOutputBuilder, Error>

pub fn amount(&self) -> u64

pub fn native_tokens(&self) -> &NativeTokens

pub fn alias_id(&self) -> &AliasId

pub fn state_index(&self) -> u32

pub fn state_metadata(&self) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]

pub fn foundry_counter(&self) -> u32

pub fn unlock_conditions(&self) -> &UnlockConditions

pub fn features(&self) -> &Features

pub fn immutable_features(&self) -> &Features

pub fn state_controller_address(&self) -> &Address

pub fn governor_address(&self) -> &Address

pub fn chain_id(&self) -> ChainId

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

Trait Implementations

impl Clone for AliasOutput

fn clone(&self) -> AliasOutput

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

impl Debug for AliasOutput

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

impl<'de> Deserialize<'de> for AliasOutput

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

impl From<&AliasOutput> for AliasOutputBuilder

fn from(output: &AliasOutput) -> Self

impl From<&AliasOutput> for AliasOutputDto

fn from(value: &AliasOutput) -> Self

impl From<AliasOutput> for Output

fn from(original: AliasOutput) -> Output

impl Ord for AliasOutput

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

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

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

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

impl Packable for AliasOutput

type UnpackError = Error

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

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

impl PartialEq<AliasOutput> for AliasOutput

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

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

impl PartialOrd<AliasOutput> for AliasOutput

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

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

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

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

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

impl Serialize for AliasOutput

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

impl StateTransitionVerifier for AliasOutput

fn creation( next_state: &Self, context: &ValidationContext<'_>) -> Result<(), StateTransitionError>

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

fn destruction( _current_state: &Self, _context: &ValidationContext<'_>) -> Result<(), StateTransitionError>

impl TryFrom<&AliasOutputDto> for AliasOutput

type Error = DtoError

fn try_from(value: &AliasOutputDto) -> Result<Self, Self::Error>

impl Eq for AliasOutput

impl StructuralEq for AliasOutput

impl StructuralPartialEq for AliasOutput

Auto Trait Implementations

impl RefUnwindSafe for AliasOutput

impl Send for AliasOutput

impl Sync for AliasOutput

impl Unpin for AliasOutput

impl UnwindSafe for AliasOutput

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

pub fn new_with_minimum_storage_deposit(
rent_structure: RentStructure,
alias_id: AliasId
) -> Result<Self, Error>

pub fn build_with_amount(
amount: u64,
alias_id: AliasId
) -> Result<AliasOutputBuilder, Error>

pub fn build_with_minimum_storage_deposit(
rent_structure: RentStructure,
alias_id: AliasId
) -> Result<AliasOutputBuilder, Error>

pub fn state_metadata(&self) -> &[u8]ⓘNotable traits for &mut [u8]`impl Write for &mut [u8]impl Read for &[u8]`

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

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

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

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

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

fn creation(
next_state: &Self,
context: &ValidationContext<'_>
) -> Result<(), StateTransitionError>

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

fn destruction(
_current_state: &Self,
_context: &ValidationContext<'_>
) -> Result<(), StateTransitionError>

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

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

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

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

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

impl<P> PackableExt for P where
P: Packable,

fn unpack_verified<T>(
bytes: T
) -> Result<P, UnpackError<<P as Packable>::UnpackError, UnexpectedEOF>> where
T: AsRef<[u8]>,

fn unpack_unverified<T>(
bytes: T
) -> Result<P, UnpackError<<P as Packable>::UnpackError, UnexpectedEOF>> where
T: AsRef<[u8]>,

fn pack_to_vec(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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

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

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

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

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

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,