Struct gear_common::gas_provider::TreeImpl
source · pub struct TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>(/* private fields */);Trait Implementations§
source§impl<TotalValue, Balance, Funds, InternalError, Error, ExternalId, NodeId, StorageMap> LockableTree for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>where
Balance: BalanceTrait,
Funds: Clone,
TotalValue: ValueStorage<Value = Balance>,
InternalError: Error,
Error: From<InternalError>,
ExternalId: Clone,
NodeId: Copy,
StorageMap: MapStorage<Key = NodeId, Value = GasNode<ExternalId, NodeId, Balance, Funds>>,
impl<TotalValue, Balance, Funds, InternalError, Error, ExternalId, NodeId, StorageMap> LockableTree for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>where
Balance: BalanceTrait,
Funds: Clone,
TotalValue: ValueStorage<Value = Balance>,
InternalError: Error,
Error: From<InternalError>,
ExternalId: Clone,
NodeId: Copy,
StorageMap: MapStorage<Key = NodeId, Value = GasNode<ExternalId, NodeId, Balance, Funds>>,
source§fn lock(
key: impl Into<Self::NodeId>,
id: LockId,
amount: Self::Balance
) -> Result<(), Self::Error>
fn lock( key: impl Into<Self::NodeId>, id: LockId, amount: Self::Balance ) -> Result<(), Self::Error>
Locking some value from underlying node balance. Read more
source§fn unlock(
key: impl Into<Self::NodeId>,
id: LockId,
amount: Self::Balance
) -> Result<(), Self::Error>
fn unlock( key: impl Into<Self::NodeId>, id: LockId, amount: Self::Balance ) -> Result<(), Self::Error>
Unlocking some value from node’s locked balance. Read more
source§impl<TotalValue, Balance, Funds, InternalError, Error, ExternalId, NodeId, StorageMap> ReservableTree for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>where
Balance: BalanceTrait,
Funds: Clone,
TotalValue: ValueStorage<Value = Balance>,
InternalError: Error,
Error: From<InternalError>,
ExternalId: Clone,
NodeId: Copy,
StorageMap: MapStorage<Key = NodeId, Value = GasNode<ExternalId, NodeId, Balance, Funds>>,
impl<TotalValue, Balance, Funds, InternalError, Error, ExternalId, NodeId, StorageMap> ReservableTree for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>where
Balance: BalanceTrait,
Funds: Clone,
TotalValue: ValueStorage<Value = Balance>,
InternalError: Error,
Error: From<InternalError>,
ExternalId: Clone,
NodeId: Copy,
StorageMap: MapStorage<Key = NodeId, Value = GasNode<ExternalId, NodeId, Balance, Funds>>,
source§fn reserve(
key: impl Into<Self::NodeId>,
new_key: impl Into<Self::NodeId>,
amount: Self::Balance
) -> Result<(), Self::Error>
fn reserve( key: impl Into<Self::NodeId>, new_key: impl Into<Self::NodeId>, amount: Self::Balance ) -> Result<(), Self::Error>
Reserve some value from underlying balance. Read more
source§fn system_reserve(
key: impl Into<Self::NodeId>,
amount: Self::Balance
) -> Result<(), Self::Error>
fn system_reserve( key: impl Into<Self::NodeId>, amount: Self::Balance ) -> Result<(), Self::Error>
Reserve some value from underlying balance. Read more
source§impl<TotalValue, Balance, Funds, InternalError, Error, ExternalId, NodeId, StorageMap> Tree for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>where
Balance: BalanceTrait,
Funds: Clone,
TotalValue: ValueStorage<Value = Balance>,
InternalError: Error,
Error: From<InternalError>,
ExternalId: Clone,
NodeId: Copy,
StorageMap: MapStorage<Key = NodeId, Value = GasNode<ExternalId, NodeId, Balance, Funds>>,
impl<TotalValue, Balance, Funds, InternalError, Error, ExternalId, NodeId, StorageMap> Tree for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>where
Balance: BalanceTrait,
Funds: Clone,
TotalValue: ValueStorage<Value = Balance>,
InternalError: Error,
Error: From<InternalError>,
ExternalId: Clone,
NodeId: Copy,
StorageMap: MapStorage<Key = NodeId, Value = GasNode<ExternalId, NodeId, Balance, Funds>>,
source§fn consume(key: impl Into<Self::NodeId>) -> ConsumeResultOf<Self>
fn consume(key: impl Into<Self::NodeId>) -> ConsumeResultOf<Self>
Marks a node with key as consumed, if possible, and tries to return
it’s value and delete it. The function performs same procedure with all
the nodes on the path from it to the root, if possible.
Marking a node as consumed is possible only for GasNode::External
and GasNode::SpecifiedLocal nodes. That is because these nodes can
be not deleted after the function call, because of, for instance,
having children refs. Such nodes as GasNode::UnspecifiedLocal
and GasNode::ReservedLocal are removed when the function is
called, so there is no need for marking them as consumed.
When consuming the node, it’s value is mutated by calling catch_value,
which tries to either return or move value upstream if possible.
Read the catch_value function’s documentation for details.
To delete node, here should be two requirements:
Self::consumewas called on the node.- The node has no children, i.e. spec/unspec refs.
So if it’s impossible to delete a node, then it’s impossible to delete its parent in the current call. Also if it’s possible to delete a node, then it doesn’t necessarily mean that its parent will be deleted. An example here could be the case, when during async execution original message went to wait list, so wasn’t consumed but the one generated during the execution of the original message went to message queue and was successfully executed.
source§fn spend(
key: impl Into<Self::NodeId>,
amount: Self::Balance
) -> Result<Self::NegativeImbalance, Self::Error>
fn spend( key: impl Into<Self::NodeId>, amount: Self::Balance ) -> Result<Self::NegativeImbalance, Self::Error>
Spends amount of gas from the ancestor of node with key id.
Calling the function is possible even if an ancestor is consumed.
§Note:
Node is considered as an ancestor of itself.
§type ExternalOrigin = ExternalId
type ExternalOrigin = ExternalId
Type representing the external owner of a value (gas) item.
§type PositiveImbalance = PositiveImbalance<Balance>
type PositiveImbalance = PositiveImbalance<Balance>
Types to denote a result of some unbalancing operation - that is
operations that create inequality between the underlying value
supply and some hypothetical “collateral” asset.
PositiveImbalance indicates that some value has been added
to circulation , i.e. total supply has increased.§type NegativeImbalance = NegativeImbalance<Balance>
type NegativeImbalance = NegativeImbalance<Balance>
NegativeImbalance indicates that some value has been removed
from circulation, i.e. total supply has decreased.type InternalError = InternalError
source§fn total_supply() -> Self::Balance
fn total_supply() -> Self::Balance
The total amount of value currently in circulation.
source§fn create(
origin: Self::ExternalOrigin,
multiplier: GasMultiplier<Self::Funds, Self::Balance>,
key: impl Into<Self::NodeId>,
amount: Self::Balance
) -> Result<Self::PositiveImbalance, Self::Error>
fn create( origin: Self::ExternalOrigin, multiplier: GasMultiplier<Self::Funds, Self::Balance>, key: impl Into<Self::NodeId>, amount: Self::Balance ) -> Result<Self::PositiveImbalance, Self::Error>
Increase the total issuance of the underlying value by creating some
amount of it and attributing it to the origin. Read moresource§fn get_origin_node(
key: impl Into<Self::NodeId>
) -> Result<OriginNodeDataOf<Self>, Self::Error>
fn get_origin_node( key: impl Into<Self::NodeId> ) -> Result<OriginNodeDataOf<Self>, Self::Error>
The id of node, external origin and funds multiplier for a key. Read more
source§fn get_limit_node(
key: impl Into<Self::NodeId>
) -> Result<(Self::Balance, Self::NodeId), Self::Error>
fn get_limit_node( key: impl Into<Self::NodeId> ) -> Result<(Self::Balance, Self::NodeId), Self::Error>
Get value associated with given id and the key of an ancestor,
that keeps this value. Read more
source§fn get_limit_node_consumed(
key: impl Into<Self::NodeId>
) -> Result<(Self::Balance, Self::NodeId), Self::Error>
fn get_limit_node_consumed( key: impl Into<Self::NodeId> ) -> Result<(Self::Balance, Self::NodeId), Self::Error>
Get value associated with given id and the key of an consumed ancestor,
that keeps this value. Read more
source§fn split_with_value(
key: impl Into<Self::NodeId>,
new_key: impl Into<Self::NodeId>,
amount: Self::Balance
) -> Result<(), Self::Error>
fn split_with_value( key: impl Into<Self::NodeId>, new_key: impl Into<Self::NodeId>, amount: Self::Balance ) -> Result<(), Self::Error>
Split underlying value. Read more
source§fn split(
key: impl Into<Self::NodeId>,
new_key: impl Into<Self::NodeId>
) -> Result<(), Self::Error>
fn split( key: impl Into<Self::NodeId>, new_key: impl Into<Self::NodeId> ) -> Result<(), Self::Error>
Split underlying value. Read more
source§fn cut(
key: impl Into<Self::NodeId>,
new_key: impl Into<Self::NodeId>,
amount: Self::Balance
) -> Result<(), Self::Error>
fn cut( key: impl Into<Self::NodeId>, new_key: impl Into<Self::NodeId>, amount: Self::Balance ) -> Result<(), Self::Error>
Cut underlying value to a reserved node. Read more
source§fn create_deposit(
key: impl Into<Self::NodeId>,
new_key: impl Into<Self::NodeId>,
amount: Self::Balance
) -> Result<(), Self::Error>
fn create_deposit( key: impl Into<Self::NodeId>, new_key: impl Into<Self::NodeId>, amount: Self::Balance ) -> Result<(), Self::Error>
Creates deposit external node to be used as pre-defined gas node.
source§fn exists_and_deposit(key: impl Into<Self::NodeId>) -> bool
fn exists_and_deposit(key: impl Into<Self::NodeId>) -> bool
Returns bool, defining does node exist and is external with deposit.
source§fn get_external(
key: impl Into<Self::NodeId>
) -> Result<Self::ExternalOrigin, Self::Error>
fn get_external( key: impl Into<Self::NodeId> ) -> Result<Self::ExternalOrigin, Self::Error>
The external origin for a key. Read more
source§fn get_funds_multiplier(
key: impl Into<Self::NodeId>
) -> Result<GasMultiplier<Self::Funds, Self::Balance>, Self::Error>
fn get_funds_multiplier( key: impl Into<Self::NodeId> ) -> Result<GasMultiplier<Self::Funds, Self::Balance>, Self::Error>
The funds multiplier for a key. Read more
source§fn get_origin_key(
key: impl Into<Self::NodeId>
) -> Result<Self::NodeId, Self::Error>
fn get_origin_key( key: impl Into<Self::NodeId> ) -> Result<Self::NodeId, Self::Error>
The id of external node for a key. Read more
Auto Trait Implementations§
impl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap> RefUnwindSafe for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>where
Error: RefUnwindSafe,
ExternalId: RefUnwindSafe,
InternalError: RefUnwindSafe,
NodeId: RefUnwindSafe,
StorageMap: RefUnwindSafe,
TotalValue: RefUnwindSafe,
impl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap> Send for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>
impl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap> Sync for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>
impl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap> Unpin for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>
impl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap> UnwindSafe for TreeImpl<TotalValue, InternalError, Error, ExternalId, NodeId, StorageMap>where
Error: UnwindSafe,
ExternalId: UnwindSafe,
InternalError: UnwindSafe,
NodeId: UnwindSafe,
StorageMap: UnwindSafe,
TotalValue: UnwindSafe,
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
§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
§fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
§fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> IsType<T> for T
impl<T> IsType<T> for T
§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
Consume self to return an equivalent value of
T. Read more§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
The counterpart to
unchecked_from.§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
Consume self to return an equivalent value of
T.